@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
178 lines (177 loc) • 6.53 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
* Creates a backend group in the specified folder and adds the specified backends to it.
* For more information, see [the official documentation](https://cloud.yandex.com/en/docs/application-load-balancer/concepts/backend-group).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const test_backend_group = new yandex.AlbBackendGroup("test-backend-group", {
* httpBackends: [{
* healthcheck: {
* httpHealthcheck: {
* path: "/",
* },
* interval: "1s",
* timeout: "1s",
* },
* http2: true,
* loadBalancingConfig: {
* panicThreshold: 50,
* },
* name: "test-http-backend",
* port: 8080,
* targetGroupIds: [yandex_alb_target_group_test_target_group.id],
* tls: {
* sni: "backend-domain.internal",
* },
* weight: 1,
* }],
* });
* ```
*
* ## Import
*
* A backend group can be imported using the `id` of the resource, e.g.
*
* ```sh
* $ pulumi import yandex:index/albBackendGroup:AlbBackendGroup default backend_group_id
* ```
*/
export declare class AlbBackendGroup extends pulumi.CustomResource {
/**
* Get an existing AlbBackendGroup 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlbBackendGroupState, opts?: pulumi.CustomResourceOptions): AlbBackendGroup;
/**
* Returns true if the given object is an instance of AlbBackendGroup. 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 AlbBackendGroup;
/**
* The backend group creation timestamp.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Description of the backend group.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
readonly folderId: pulumi.Output<string>;
/**
* Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
readonly grpcBackends: pulumi.Output<outputs.AlbBackendGroupGrpcBackend[] | undefined>;
/**
* Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
readonly httpBackends: pulumi.Output<outputs.AlbBackendGroupHttpBackend[] | undefined>;
/**
* Labels to assign to this backend group.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the backend.
*/
readonly name: pulumi.Output<string>;
/**
* Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
readonly streamBackends: pulumi.Output<outputs.AlbBackendGroupStreamBackend[] | undefined>;
/**
* Create a AlbBackendGroup 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?: AlbBackendGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AlbBackendGroup resources.
*/
export interface AlbBackendGroupState {
/**
* The backend group creation timestamp.
*/
createdAt?: pulumi.Input<string>;
/**
* Description of the backend group.
*/
description?: pulumi.Input<string>;
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
grpcBackends?: pulumi.Input<pulumi.Input<inputs.AlbBackendGroupGrpcBackend>[]>;
/**
* Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
httpBackends?: pulumi.Input<pulumi.Input<inputs.AlbBackendGroupHttpBackend>[]>;
/**
* Labels to assign to this backend group.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the backend.
*/
name?: pulumi.Input<string>;
/**
* Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
streamBackends?: pulumi.Input<pulumi.Input<inputs.AlbBackendGroupStreamBackend>[]>;
}
/**
* The set of arguments for constructing a AlbBackendGroup resource.
*/
export interface AlbBackendGroupArgs {
/**
* Description of the backend group.
*/
description?: pulumi.Input<string>;
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* Grpc backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
grpcBackends?: pulumi.Input<pulumi.Input<inputs.AlbBackendGroupGrpcBackend>[]>;
/**
* Http backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
httpBackends?: pulumi.Input<pulumi.Input<inputs.AlbBackendGroupHttpBackend>[]>;
/**
* Labels to assign to this backend group.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the backend.
*/
name?: pulumi.Input<string>;
/**
* Stream backend specification that will be used by the ALB Backend Group. Structure is documented below.
*/
streamBackends?: pulumi.Input<pulumi.Input<inputs.AlbBackendGroupStreamBackend>[]>;
}