@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
105 lines (104 loc) • 4.51 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
*/
export declare class Listener extends pulumi.CustomResource {
/**
* Get an existing Listener resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Listener;
/**
* Returns true if the given object is an instance of Listener. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Listener;
/**
* The Amazon Resource Name (ARN) of the listener.
*/
readonly arn: pulumi.Output<string>;
/**
* The ID of the listener.
*/
readonly awsId: pulumi.Output<string>;
/**
* The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
*/
readonly defaultAction: pulumi.Output<outputs.vpclattice.ListenerDefaultAction>;
/**
* The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
*
* If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.
*/
readonly port: pulumi.Output<number | undefined>;
/**
* The listener protocol.
*/
readonly protocol: pulumi.Output<enums.vpclattice.ListenerProtocol>;
/**
* The Amazon Resource Name (ARN) of the service.
*/
readonly serviceArn: pulumi.Output<string>;
/**
* The ID of the service.
*/
readonly serviceId: pulumi.Output<string>;
/**
* The ID or ARN of the service.
*/
readonly serviceIdentifier: pulumi.Output<string | undefined>;
/**
* The tags for the listener.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a Listener resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ListenerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Listener resource.
*/
export interface ListenerArgs {
/**
* The action for the default rule. Each listener has a default rule. The default rule is used if no other rules match.
*/
defaultAction: pulumi.Input<inputs.vpclattice.ListenerDefaultActionArgs>;
/**
* The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
*
* If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.
*/
name?: pulumi.Input<string>;
/**
* The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.
*/
port?: pulumi.Input<number>;
/**
* The listener protocol.
*/
protocol: pulumi.Input<enums.vpclattice.ListenerProtocol>;
/**
* The ID or ARN of the service.
*/
serviceIdentifier?: pulumi.Input<string>;
/**
* The tags for the listener.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}