Docs Home
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
avi.Poolgroup
Explore with Pulumi AI
<!–
Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0
–>
layout: “avi”
page_title: “Avi: avi.Poolgroup” sidebar_current: “docs-avi-resource-poolgroup” description: |- Creates and manages Avi PoolGroup.
avi.Poolgroup
The PoolGroup resource allows the creation and management of Avi PoolGroup
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";
const foo = new avi.Poolgroup("foo", {tenantRef: "/api/tenant/?name=admin"});
import pulumi
import pulumi_avi as avi
foo = avi.Poolgroup("foo", tenant_ref="/api/tenant/?name=admin")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := avi.NewPoolgroup(ctx, "foo", &avi.PoolgroupArgs{
TenantRef: pulumi.String("/api/tenant/?name=admin"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;
return await Deployment.RunAsync(() =>
{
var foo = new Avi.Poolgroup("foo", new()
{
TenantRef = "/api/tenant/?name=admin",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Poolgroup;
import com.pulumi.avi.PoolgroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var foo = new Poolgroup("foo", PoolgroupArgs.builder()
.tenantRef("/api/tenant/?name=admin")
.build());
}
}
resources:
foo:
type: avi:Poolgroup
properties:
tenantRef: /api/tenant/?name=admin
Create Poolgroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Poolgroup(name: string, args?: PoolgroupArgs, opts?: CustomResourceOptions);@overload
def Poolgroup(resource_name: str,
args: Optional[PoolgroupArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Poolgroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
cloud_config_cksum: Optional[str] = None,
cloud_ref: Optional[str] = None,
configpb_attributes: Optional[Sequence[PoolgroupConfigpbAttributeArgs]] = None,
created_by: Optional[str] = None,
deactivate_primary_pool_on_down: Optional[str] = None,
deployment_policy_ref: Optional[str] = None,
description: Optional[str] = None,
fail_actions: Optional[Sequence[PoolgroupFailActionArgs]] = None,
implicit_priority_labels: Optional[str] = None,
markers: Optional[Sequence[PoolgroupMarkerArgs]] = None,
members: Optional[Sequence[PoolgroupMemberArgs]] = None,
min_servers: Optional[str] = None,
name: Optional[str] = None,
poolgroup_id: Optional[str] = None,
priority_labels_ref: Optional[str] = None,
service_metadata: Optional[str] = None,
tenant_ref: Optional[str] = None,
uuid: Optional[str] = None)func NewPoolgroup(ctx *Context, name string, args *PoolgroupArgs, opts ...ResourceOption) (*Poolgroup, error)public Poolgroup(string name, PoolgroupArgs? args = null, CustomResourceOptions? opts = null)
public Poolgroup(String name, PoolgroupArgs args)
public Poolgroup(String name, PoolgroupArgs args, CustomResourceOptions options)
type: avi:Poolgroup
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 PoolgroupArgs
- 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 PoolgroupArgs
- 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 PoolgroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PoolgroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PoolgroupArgs
- 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 poolgroupResource = new Avi.Poolgroup("poolgroupResource", new()
{
CloudConfigCksum = "string",
CloudRef = "string",
ConfigpbAttributes = new[]
{
new Avi.Inputs.PoolgroupConfigpbAttributeArgs
{
Version = "string",
},
},
CreatedBy = "string",
DeactivatePrimaryPoolOnDown = "string",
DeploymentPolicyRef = "string",
Description = "string",
FailActions = new[]
{
new Avi.Inputs.PoolgroupFailActionArgs
{
Type = "string",
LocalRsps = new[]
{
new Avi.Inputs.PoolgroupFailActionLocalRspArgs
{
Files = new[]
{
new Avi.Inputs.PoolgroupFailActionLocalRspFileArgs
{
ContentType = "string",
FileContent = "string",
FileLength = "string",
},
},
StatusCode = "string",
},
},
Redirects = new[]
{
new Avi.Inputs.PoolgroupFailActionRedirectArgs
{
Host = "string",
Path = "string",
Protocol = "string",
Query = "string",
StatusCode = "string",
},
},
},
},
ImplicitPriorityLabels = "string",
Markers = new[]
{
new Avi.Inputs.PoolgroupMarkerArgs
{
Key = "string",
Values = new[]
{
"string",
},
},
},
Members = new[]
{
new Avi.Inputs.PoolgroupMemberArgs
{
PoolRef = "string",
DeploymentState = "string",
PriorityLabel = "string",
Ratio = "string",
},
},
MinServers = "string",
Name = "string",
PoolgroupId = "string",
PriorityLabelsRef = "string",
ServiceMetadata = "string",
TenantRef = "string",
Uuid = "string",
});
example, err := avi.NewPoolgroup(ctx, "poolgroupResource", &avi.PoolgroupArgs{
CloudConfigCksum: pulumi.String("string"),
CloudRef: pulumi.String("string"),
ConfigpbAttributes: avi.PoolgroupConfigpbAttributeArray{
&avi.PoolgroupConfigpbAttributeArgs{
Version: pulumi.String("string"),
},
},
CreatedBy: pulumi.String("string"),
DeactivatePrimaryPoolOnDown: pulumi.String("string"),
DeploymentPolicyRef: pulumi.String("string"),
Description: pulumi.String("string"),
FailActions: avi.PoolgroupFailActionArray{
&avi.PoolgroupFailActionArgs{
Type: pulumi.String("string"),
LocalRsps: avi.PoolgroupFailActionLocalRspArray{
&avi.PoolgroupFailActionLocalRspArgs{
Files: avi.PoolgroupFailActionLocalRspFileArray{
&avi.PoolgroupFailActionLocalRspFileArgs{
ContentType: pulumi.String("string"),
FileContent: pulumi.String("string"),
FileLength: pulumi.String("string"),
},
},
StatusCode: pulumi.String("string"),
},
},
Redirects: avi.PoolgroupFailActionRedirectArray{
&avi.PoolgroupFailActionRedirectArgs{
Host: pulumi.String("string"),
Path: pulumi.String("string"),
Protocol: pulumi.String("string"),
Query: pulumi.String("string"),
StatusCode: pulumi.String("string"),
},
},
},
},
ImplicitPriorityLabels: pulumi.String("string"),
Markers: avi.PoolgroupMarkerArray{
&avi.PoolgroupMarkerArgs{
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Members: avi.PoolgroupMemberArray{
&avi.PoolgroupMemberArgs{
PoolRef: pulumi.String("string"),
DeploymentState: pulumi.String("string"),
PriorityLabel: pulumi.String("string"),
Ratio: pulumi.String("string"),
},
},
MinServers: pulumi.String("string"),
Name: pulumi.String("string"),
PoolgroupId: pulumi.String("string"),
PriorityLabelsRef: pulumi.String("string"),
ServiceMetadata: pulumi.String("string"),
TenantRef: pulumi.String("string"),
Uuid: pulumi.String("string"),
})
var poolgroupResource = new Poolgroup("poolgroupResource", PoolgroupArgs.builder()
.cloudConfigCksum("string")
.cloudRef("string")
.configpbAttributes(PoolgroupConfigpbAttributeArgs.builder()
.version("string")
.build())
.createdBy("string")
.deactivatePrimaryPoolOnDown("string")
.deploymentPolicyRef("string")
.description("string")
.failActions(PoolgroupFailActionArgs.builder()
.type("string")
.localRsps(PoolgroupFailActionLocalRspArgs.builder()
.files(PoolgroupFailActionLocalRspFileArgs.builder()
.contentType("string")
.fileContent("string")
.fileLength("string")
.build())
.statusCode("string")
.build())
.redirects(PoolgroupFailActionRedirectArgs.builder()
.host("string")
.path("string")
.protocol("string")
.query("string")
.statusCode("string")
.build())
.build())
.implicitPriorityLabels("string")
.markers(PoolgroupMarkerArgs.builder()
.key("string")
.values("string")
.build())
.members(PoolgroupMemberArgs.builder()
.poolRef("string")
.deploymentState("string")
.priorityLabel("string")
.ratio("string")
.build())
.minServers("string")
.name("string")
.poolgroupId("string")
.priorityLabelsRef("string")
.serviceMetadata("string")
.tenantRef("string")
.uuid("string")
.build());
poolgroup_resource = avi.Poolgroup("poolgroupResource",
cloud_config_cksum="string",
cloud_ref="string",
configpb_attributes=[{
"version": "string",
}],
created_by="string",
deactivate_primary_pool_on_down="string",
deployment_policy_ref="string",
description="string",
fail_actions=[{
"type": "string",
"local_rsps": [{
"files": [{
"content_type": "string",
"file_content": "string",
"file_length": "string",
}],
"status_code": "string",
}],
"redirects": [{
"host": "string",
"path": "string",
"protocol": "string",
"query": "string",
"status_code": "string",
}],
}],
implicit_priority_labels="string",
markers=[{
"key": "string",
"values": ["string"],
}],
members=[{
"pool_ref": "string",
"deployment_state": "string",
"priority_label": "string",
"ratio": "string",
}],
min_servers="string",
name="string",
poolgroup_id="string",
priority_labels_ref="string",
service_metadata="string",
tenant_ref="string",
uuid="string")
const poolgroupResource = new avi.Poolgroup("poolgroupResource", {
cloudConfigCksum: "string",
cloudRef: "string",
configpbAttributes: [{
version: "string",
}],
createdBy: "string",
deactivatePrimaryPoolOnDown: "string",
deploymentPolicyRef: "string",
description: "string",
failActions: [{
type: "string",
localRsps: [{
files: [{
contentType: "string",
fileContent: "string",
fileLength: "string",
}],
statusCode: "string",
}],
redirects: [{
host: "string",
path: "string",
protocol: "string",
query: "string",
statusCode: "string",
}],
}],
implicitPriorityLabels: "string",
markers: [{
key: "string",
values: ["string"],
}],
members: [{
poolRef: "string",
deploymentState: "string",
priorityLabel: "string",
ratio: "string",
}],
minServers: "string",
name: "string",
poolgroupId: "string",
priorityLabelsRef: "string",
serviceMetadata: "string",
tenantRef: "string",
uuid: "string",
});
type: avi:Poolgroup
properties:
cloudConfigCksum: string
cloudRef: string
configpbAttributes:
- version: string
createdBy: string
deactivatePrimaryPoolOnDown: string
deploymentPolicyRef: string
description: string
failActions:
- localRsps:
- files:
- contentType: string
fileContent: string
fileLength: string
statusCode: string
redirects:
- host: string
path: string
protocol: string
query: string
statusCode: string
type: string
implicitPriorityLabels: string
markers:
- key: string
values:
- string
members:
- deploymentState: string
poolRef: string
priorityLabel: string
ratio: string
minServers: string
name: string
poolgroupId: string
priorityLabelsRef: string
serviceMetadata: string
tenantRef: string
uuid: string
Poolgroup 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 Poolgroup resource accepts the following input properties:
- Cloud
Config stringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Cloud
Ref string - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes List<PoolgroupConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Deactivate
Primary stringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- Deployment
Policy stringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- Description string
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Fail
Actions List<PoolgroupFail Action> - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- Implicit
Priority stringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
List<Poolgroup
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Members
List<Poolgroup
Member> - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Servers string - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- Name string
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Poolgroup
Id string - Priority
Labels stringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- Service
Metadata string - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Cloud
Config stringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Cloud
Ref string - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes []PoolgroupConfigpb Attribute Args - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Deactivate
Primary stringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- Deployment
Policy stringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- Description string
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Fail
Actions []PoolgroupFail Action Args - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- Implicit
Priority stringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
[]Poolgroup
Marker Args - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Members
[]Poolgroup
Member Args - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Servers string - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- Name string
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Poolgroup
Id string - Priority
Labels stringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- Service
Metadata string - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Config StringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Ref String - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<PoolgroupConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate
Primary StringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment
Policy StringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description String
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail
Actions List<PoolgroupFail Action> - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit
Priority StringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
List<Poolgroup
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members
List<Poolgroup
Member> - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Servers String - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name String
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup
Id String - priority
Labels StringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service
Metadata String - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Config stringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Ref string - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes PoolgroupConfigpb Attribute[] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By string - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate
Primary stringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment
Policy stringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description string
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail
Actions PoolgroupFail Action[] - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit
Priority stringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Poolgroup
Marker[] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members
Poolgroup
Member[] - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Servers string - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name string
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup
Id string - priority
Labels stringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service
Metadata string - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref string - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud_
config_ strcksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud_
ref str - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes Sequence[PoolgroupConfigpb Attribute Args] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created_
by str - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate_
primary_ strpool_ on_ down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment_
policy_ strref - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description str
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail_
actions Sequence[PoolgroupFail Action Args] - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit_
priority_ strlabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Sequence[Poolgroup
Marker Args] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members
Sequence[Poolgroup
Member Args] - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min_
servers str - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name str
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup_
id str - priority_
labels_ strref - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service_
metadata str - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref str - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid str
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Config StringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Ref String - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<Property Map> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate
Primary StringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment
Policy StringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description String
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail
Actions List<Property Map> - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit
Priority StringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers List<Property Map>
- List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members List<Property Map>
- List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Servers String - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name String
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup
Id String - priority
Labels StringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service
Metadata String - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Outputs
All input properties are implicitly available as output properties. Additionally, the Poolgroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Poolgroup Resource
Get an existing Poolgroup 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?: PoolgroupState, opts?: CustomResourceOptions): Poolgroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cloud_config_cksum: Optional[str] = None,
cloud_ref: Optional[str] = None,
configpb_attributes: Optional[Sequence[PoolgroupConfigpbAttributeArgs]] = None,
created_by: Optional[str] = None,
deactivate_primary_pool_on_down: Optional[str] = None,
deployment_policy_ref: Optional[str] = None,
description: Optional[str] = None,
fail_actions: Optional[Sequence[PoolgroupFailActionArgs]] = None,
implicit_priority_labels: Optional[str] = None,
markers: Optional[Sequence[PoolgroupMarkerArgs]] = None,
members: Optional[Sequence[PoolgroupMemberArgs]] = None,
min_servers: Optional[str] = None,
name: Optional[str] = None,
poolgroup_id: Optional[str] = None,
priority_labels_ref: Optional[str] = None,
service_metadata: Optional[str] = None,
tenant_ref: Optional[str] = None,
uuid: Optional[str] = None) -> Poolgroupfunc GetPoolgroup(ctx *Context, name string, id IDInput, state *PoolgroupState, opts ...ResourceOption) (*Poolgroup, error)public static Poolgroup Get(string name, Input<string> id, PoolgroupState? state, CustomResourceOptions? opts = null)public static Poolgroup get(String name, Output<String> id, PoolgroupState state, CustomResourceOptions options)resources: _: type: avi:Poolgroup get: id: ${id}- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Cloud
Config stringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Cloud
Ref string - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes List<PoolgroupConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Deactivate
Primary stringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- Deployment
Policy stringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- Description string
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Fail
Actions List<PoolgroupFail Action> - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- Implicit
Priority stringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
List<Poolgroup
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Members
List<Poolgroup
Member> - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Servers string - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- Name string
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Poolgroup
Id string - Priority
Labels stringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- Service
Metadata string - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Cloud
Config stringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Cloud
Ref string - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Configpb
Attributes []PoolgroupConfigpb Attribute Args - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Created
By string - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Deactivate
Primary stringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- Deployment
Policy stringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- Description string
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Fail
Actions []PoolgroupFail Action Args - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- Implicit
Priority stringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Markers
[]Poolgroup
Marker Args - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Members
[]Poolgroup
Member Args - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Min
Servers string - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- Name string
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Poolgroup
Id string - Priority
Labels stringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- Service
Metadata string - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Tenant
Ref string - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Uuid string
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Config StringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Ref String - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<PoolgroupConfigpb Attribute> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate
Primary StringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment
Policy StringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description String
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail
Actions List<PoolgroupFail Action> - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit
Priority StringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
List<Poolgroup
Marker> - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members
List<Poolgroup
Member> - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Servers String - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name String
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup
Id String - priority
Labels StringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service
Metadata String - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Config stringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Ref string - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes PoolgroupConfigpb Attribute[] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By string - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate
Primary stringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment
Policy stringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description string
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail
Actions PoolgroupFail Action[] - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit
Priority stringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Poolgroup
Marker[] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members
Poolgroup
Member[] - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Servers string - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name string
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup
Id string - priority
Labels stringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service
Metadata string - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref string - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid string
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud_
config_ strcksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud_
ref str - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb_
attributes Sequence[PoolgroupConfigpb Attribute Args] - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created_
by str - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate_
primary_ strpool_ on_ down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment_
policy_ strref - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description str
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail_
actions Sequence[PoolgroupFail Action Args] - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit_
priority_ strlabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers
Sequence[Poolgroup
Marker Args] - List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members
Sequence[Poolgroup
Member Args] - List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min_
servers str - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name str
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup_
id str - priority_
labels_ strref - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service_
metadata str - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant_
ref str - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid str
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Config StringCksum - Checksum of cloud configuration for poolgroup. Internally set by cloud connector. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- cloud
Ref String - It is a reference to an object of type cloud. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- configpb
Attributes List<Property Map> - Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- created
By String - Name of the user who created the object. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- deactivate
Primary StringPool On Down - Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Field introduced in 20.1.7, 21.1.2, 21.1.3. Allowed with any value in enterprise, enterprise with cloud services edition.
- deployment
Policy StringRef - When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type poolgroupdeploymentpolicy. Allowed with any value in enterprise, enterprise with cloud services edition.
- description String
- Description of pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- fail
Actions List<Property Map> - Enable an action - close connection, http redirect, or local http response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure. Allowed with any value in enterprise, enterprise with cloud services edition.
- implicit
Priority StringLabels - Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- markers List<Property Map>
- List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- members List<Property Map>
- List of pool group members object of type poolgroupmember. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- min
Servers String - The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - disable. Allowed with any value in enterprise, enterprise with cloud services edition. Allowed in essentials (allowed values- 0), basic (allowed values- 0) edition.
- name String
- The name of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- poolgroup
Id String - priority
Labels StringRef - Uuid of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type prioritylabels. Allowed with any value in enterprise, enterprise with cloud services edition.
- service
Metadata String - Metadata pertaining to the service provided by this poolgroup. In openshift/kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by avi vantage. Field introduced in 17.2.14,18.1.5,18.2.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- tenant
Ref String - It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- uuid String
- Uuid of the pool group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Supporting Types
PoolgroupConfigpbAttribute, PoolgroupConfigpbAttributeArgs
- Version string
- Version string
- version String
- version string
- version str
- version String
PoolgroupFailAction, PoolgroupFailActionArgs
PoolgroupFailActionLocalRsp, PoolgroupFailActionLocalRspArgs
PoolgroupFailActionLocalRspFile, PoolgroupFailActionLocalRspFileArgs
- Content
Type string - File
Content string - File
Length string
- Content
Type string - File
Content string - File
Length string
- content
Type String - file
Content String - file
Length String
- content
Type string - file
Content string - file
Length string
- content_
type str - file_
content str - file_
length str
- content
Type String - file
Content String - file
Length String
PoolgroupFailActionRedirect, PoolgroupFailActionRedirectArgs
- Host string
- Path string
- Protocol string
- Query string
- Status
Code string
- Host string
- Path string
- Protocol string
- Query string
- Status
Code string
- host String
- path String
- protocol String
- query String
- status
Code String
- host string
- path string
- protocol string
- query string
- status
Code string
- host str
- path str
- protocol str
- query str
- status_
code str
- host String
- path String
- protocol String
- query String
- status
Code String
PoolgroupMarker, PoolgroupMarkerArgs
PoolgroupMember, PoolgroupMemberArgs
- Pool
Ref string - Deployment
State string - Priority
Label string - Ratio string
- Pool
Ref string - Deployment
State string - Priority
Label string - Ratio string
- pool
Ref String - deployment
State String - priority
Label String - ratio String
- pool
Ref string - deployment
State string - priority
Label string - ratio string
- pool_
ref str - deployment_
state str - priority_
label str - ratio str
- pool
Ref String - deployment
State String - priority
Label String - ratio String
Package Details
- Repository
- avi vmware/terraform-provider-avi
- License
- Notes
- This Pulumi package is based on the
aviTerraform Provider.