We recommend new projects start with resources from the AWS provider.
aws-native.globalaccelerator.Listener
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Listener resource accepts the following input properties:
- AcceleratorArn string
- The Amazon Resource Name (ARN) of the accelerator.
- PortRanges List<Pulumi.Aws Native. Global Accelerator. Inputs. Listener Port Range> 
- The list of port ranges for the connections from clients to the accelerator.
- Protocol
Pulumi.Aws Native. Global Accelerator. Listener Protocol 
- The protocol for the listener.
- ClientAffinity Pulumi.Aws Native. Global Accelerator. Listener Client Affinity 
- 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 []ListenerPort Range Args 
- The list of port ranges for the connections from clients to the accelerator.
- Protocol
ListenerProtocol 
- The protocol for the listener.
- ClientAffinity ListenerClient Affinity 
- 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<ListenerPort Range> 
- The list of port ranges for the connections from clients to the accelerator.
- protocol
ListenerProtocol 
- The protocol for the listener.
- clientAffinity ListenerClient Affinity 
- 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 ListenerPort Range[] 
- The list of port ranges for the connections from clients to the accelerator.
- protocol
ListenerProtocol 
- The protocol for the listener.
- clientAffinity ListenerClient Affinity 
- 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[ListenerPort Range Args] 
- The list of port ranges for the connections from clients to the accelerator.
- protocol
ListenerProtocol 
- The protocol for the listener.
- client_affinity ListenerClient Affinity 
- 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>
- The list of port ranges for the connections from clients to the accelerator.
- 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
- ListenerClient Affinity None 
- NONE
- ListenerClient Affinity Source Ip 
- 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      
ListenerProtocol, ListenerProtocolArgs    
- Tcp
- TCP
- Udp
- UDP
- ListenerProtocol Tcp 
- TCP
- ListenerProtocol Udp 
- 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
We recommend new projects start with resources from the AWS provider.