1. Packages
  2. AWS Native
  3. API Docs
  4. globalaccelerator
  5. Listener

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.globalaccelerator.Listener

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource Type definition for AWS::GlobalAccelerator::Listener

    Create Listener Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);
    @overload
    def Listener(resource_name: str,
                 args: ListenerArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Listener(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 accelerator_arn: Optional[str] = None,
                 port_ranges: Optional[Sequence[ListenerPortRangeArgs]] = None,
                 protocol: Optional[ListenerProtocol] = None,
                 client_affinity: Optional[ListenerClientAffinity] = None)
    func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)
    public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
    public Listener(String name, ListenerArgs args)
    public Listener(String name, ListenerArgs args, CustomResourceOptions options)
    
    type: aws-native:globalaccelerator:Listener
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ListenerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const aws_nativeListenerResource = new aws_native.globalaccelerator.Listener("aws-nativeListenerResource", {
        acceleratorArn: "string",
        portRanges: [{
            fromPort: 0,
            toPort: 0,
        }],
        protocol: aws_native.globalaccelerator.ListenerProtocol.Tcp,
        clientAffinity: aws_native.globalaccelerator.ListenerClientAffinity.None,
    });
    
    Coming soon!
    

    Listener Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Listener resource accepts the following input properties:

    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    PortRanges List<Pulumi.AwsNative.GlobalAccelerator.Inputs.ListenerPortRange>
    Protocol Pulumi.AwsNative.GlobalAccelerator.ListenerProtocol
    The protocol for the listener.
    ClientAffinity Pulumi.AwsNative.GlobalAccelerator.ListenerClientAffinity
    Client affinity lets you direct all requests from a user to the same endpoint.
    AcceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    PortRanges []ListenerPortRangeArgs
    Protocol ListenerProtocol
    The protocol for the listener.
    ClientAffinity ListenerClientAffinity
    Client affinity lets you direct all requests from a user to the same endpoint.
    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.
    portRanges List<ListenerPortRange>
    protocol ListenerProtocol
    The protocol for the listener.
    clientAffinity ListenerClientAffinity
    Client affinity lets you direct all requests from a user to the same endpoint.
    acceleratorArn string
    The Amazon Resource Name (ARN) of the accelerator.
    portRanges ListenerPortRange[]
    protocol ListenerProtocol
    The protocol for the listener.
    clientAffinity ListenerClientAffinity
    Client affinity lets you direct all requests from a user to the same endpoint.
    accelerator_arn str
    The Amazon Resource Name (ARN) of the accelerator.
    port_ranges Sequence[ListenerPortRangeArgs]
    protocol ListenerProtocol
    The protocol for the listener.
    client_affinity ListenerClientAffinity
    Client affinity lets you direct all requests from a user to the same endpoint.
    acceleratorArn String
    The Amazon Resource Name (ARN) of the accelerator.
    portRanges List<Property Map>
    protocol "TCP" | "UDP"
    The protocol for the listener.
    clientAffinity "NONE" | "SOURCE_IP"
    Client affinity lets you direct all requests from a user to the same endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerArn string
    The Amazon Resource Name (ARN) of the listener.
    Id string
    The provider-assigned unique ID for this managed resource.
    ListenerArn string
    The Amazon Resource Name (ARN) of the listener.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerArn String
    The Amazon Resource Name (ARN) of the listener.
    id string
    The provider-assigned unique ID for this managed resource.
    listenerArn string
    The Amazon Resource Name (ARN) of the listener.
    id str
    The provider-assigned unique ID for this managed resource.
    listener_arn str
    The Amazon Resource Name (ARN) of the listener.
    id String
    The provider-assigned unique ID for this managed resource.
    listenerArn String
    The Amazon Resource Name (ARN) of the listener.

    Supporting Types

    ListenerClientAffinity, ListenerClientAffinityArgs

    None
    NONE
    SourceIp
    SOURCE_IP
    ListenerClientAffinityNone
    NONE
    ListenerClientAffinitySourceIp
    SOURCE_IP
    None
    NONE
    SourceIp
    SOURCE_IP
    None
    NONE
    SourceIp
    SOURCE_IP
    NONE
    NONE
    SOURCE_IP
    SOURCE_IP
    "NONE"
    NONE
    "SOURCE_IP"
    SOURCE_IP

    ListenerPortRange, ListenerPortRangeArgs

    fromPort Integer
    toPort Integer
    fromPort number
    toPort number
    fromPort Number
    toPort Number

    ListenerProtocol, ListenerProtocolArgs

    Tcp
    TCP
    Udp
    UDP
    ListenerProtocolTcp
    TCP
    ListenerProtocolUdp
    UDP
    Tcp
    TCP
    Udp
    UDP
    Tcp
    TCP
    Udp
    UDP
    TCP
    TCP
    UDP
    UDP
    "TCP"
    TCP
    "UDP"
    UDP

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi