Docs Home
alicloud.gwlb.Listener
Explore with Pulumi AI
Provides a GWLB Listener resource.
For information about GWLB Listener and how to use it, see What is Listener.
NOTE: Available since v1.234.0.
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,
load_balancer_id: Optional[str] = None,
server_group_id: Optional[str] = None,
dry_run: Optional[bool] = None,
listener_description: Optional[str] = None,
tags: Optional[Mapping[str, str]] = 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: alicloud:gwlb:Listener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ListenerArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ListenerArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ListenerArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ListenerArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var examplelistenerResourceResourceFromGwlblistener = new AliCloud.Gwlb.Listener("examplelistenerResourceResourceFromGwlblistener", new()
{
LoadBalancerId = "string",
ServerGroupId = "string",
DryRun = false,
ListenerDescription = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := gwlb.NewListener(ctx, "examplelistenerResourceResourceFromGwlblistener", &gwlb.ListenerArgs{
LoadBalancerId: pulumi.String("string"),
ServerGroupId: pulumi.String("string"),
DryRun: pulumi.Bool(false),
ListenerDescription: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var examplelistenerResourceResourceFromGwlblistener = new Listener("examplelistenerResourceResourceFromGwlblistener", ListenerArgs.builder()
.loadBalancerId("string")
.serverGroupId("string")
.dryRun(false)
.listenerDescription("string")
.tags(Map.of("string", "string"))
.build());
examplelistener_resource_resource_from_gwlblistener = alicloud.gwlb.Listener("examplelistenerResourceResourceFromGwlblistener",
load_balancer_id="string",
server_group_id="string",
dry_run=False,
listener_description="string",
tags={
"string": "string",
})
const examplelistenerResourceResourceFromGwlblistener = new alicloud.gwlb.Listener("examplelistenerResourceResourceFromGwlblistener", {
loadBalancerId: "string",
serverGroupId: "string",
dryRun: false,
listenerDescription: "string",
tags: {
string: "string",
},
});
type: alicloud:gwlb:Listener
properties:
dryRun: false
listenerDescription: string
loadBalancerId: string
serverGroupId: string
tags:
string: string
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:
- Load
Balancer Id stringThis property is required. 
Changes to this property will trigger replacement. - The GWLB instance ID.
- Server
Group Id This property is required. string - The server group ID.
- Dry
Run bool - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- Listener
Description string The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- Dictionary<string, string>
- The tags. You can specify at most 20 tags in each call.
- Load
Balancer Id stringThis property is required. Changes to this property will trigger replacement. - The GWLB instance ID.
- Server
Group Id This property is required. string - The server group ID.
- Dry
Run bool - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- Listener
Description string The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- map[string]string
- The tags. You can specify at most 20 tags in each call.
- load
Balancer Id StringThis property is required. Changes to this property will trigger replacement. - The GWLB instance ID.
- server
Group Id This property is required. String - The server group ID.
- dry
Run Boolean - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener
Description String The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- Map<String,String>
- The tags. You can specify at most 20 tags in each call.
- load
Balancer Id stringThis property is required. Changes to this property will trigger replacement. - The GWLB instance ID.
- server
Group Id This property is required. string - The server group ID.
- dry
Run boolean - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener
Description string The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- {[key: string]: string}
- The tags. You can specify at most 20 tags in each call.
- load_
balancer_ id strThis property is required. Changes to this property will trigger replacement. - The GWLB instance ID.
- server_
group_ id This property is required. str - The server group ID.
- dry_
run bool - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener_
description str The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- Mapping[str, str]
- The tags. You can specify at most 20 tags in each call.
- load
Balancer Id StringThis property is required. Changes to this property will trigger replacement. - The GWLB instance ID.
- server
Group Id This property is required. String - The server group ID.
- dry
Run Boolean - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener
Description String The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- Map<String>
- The tags. You can specify at most 20 tags in each call.
Outputs
All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:
Look up Existing Listener Resource
Get an existing Listener resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ListenerState, opts?: CustomResourceOptions): Listener@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dry_run: Optional[bool] = None,
listener_description: Optional[str] = None,
load_balancer_id: Optional[str] = None,
region_id: Optional[str] = None,
server_group_id: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> Listenerfunc GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)resources: _: type: alicloud:gwlb:Listener get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Dry
Run bool - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- Listener
Description string The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- Load
Balancer Id - The GWLB instance ID.
- Region
Id string - The region ID.
- Server
Group stringId - The server group ID.
- Status string
- The status of the listener.
- Dictionary<string, string>
- The tags. You can specify at most 20 tags in each call.
- Dry
Run bool - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- Listener
Description string The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- Load
Balancer Id - The GWLB instance ID.
- Region
Id string - The region ID.
- Server
Group stringId - The server group ID.
- Status string
- The status of the listener.
- map[string]string
- The tags. You can specify at most 20 tags in each call.
- dry
Run Boolean - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener
Description String The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- load
Balancer Id - The GWLB instance ID.
- region
Id String - The region ID.
- server
Group StringId - The server group ID.
- status String
- The status of the listener.
- Map<String,String>
- The tags. You can specify at most 20 tags in each call.
- dry
Run boolean - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener
Description string The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- load
Balancer Id - The GWLB instance ID.
- region
Id string - The region ID.
- server
Group stringId - The server group ID.
- status string
- The status of the listener.
- {[key: string]: string}
- The tags. You can specify at most 20 tags in each call.
- dry_
run bool - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener_
description str The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- load_
balancer_ id - The GWLB instance ID.
- region_
id str - The region ID.
- server_
group_ strid - The server group ID.
- status str
- The status of the listener.
- Mapping[str, str]
- The tags. You can specify at most 20 tags in each call.
- dry
Run Boolean - Specifies whether to perform a dry run, without performing the actual request. Valid values:
- listener
Description String The description of the listener.
The description must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).
- load
Balancer Id - The GWLB instance ID.
- region
Id String - The region ID.
- server
Group StringId - The server group ID.
- status String
- The status of the listener.
- Map<String>
- The tags. You can specify at most 20 tags in each call.
Import
GWLB Listener can be imported using the id, e.g.
$ pulumi import alicloud:gwlb/listener:Listener example <id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.