Yandex

v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

getComputeInstanceGroup

Get information about a Yandex Compute instance group.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const myGroup = pulumi.output(yandex.getComputeInstanceGroup({
    instanceGroupId: "some_instance_group_id",
}));

export const instanceExternalIp = myGroup.instances[*].networkInterface.0.natIpAddress;

Coming soon!

Using getComputeInstanceGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getComputeInstanceGroup(args: GetComputeInstanceGroupArgs, opts?: InvokeOptions): Promise<GetComputeInstanceGroupResult>
function getComputeInstanceGroupOutput(args: GetComputeInstanceGroupOutputArgs, opts?: InvokeOptions): Output<GetComputeInstanceGroupResult>
def get_compute_instance_group(instance_group_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetComputeInstanceGroupResult
def get_compute_instance_group_output(instance_group_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetComputeInstanceGroupResult]
func LookupComputeInstanceGroup(ctx *Context, args *LookupComputeInstanceGroupArgs, opts ...InvokeOption) (*LookupComputeInstanceGroupResult, error)
func LookupComputeInstanceGroupOutput(ctx *Context, args *LookupComputeInstanceGroupOutputArgs, opts ...InvokeOption) LookupComputeInstanceGroupResultOutput

> Note: This function is named LookupComputeInstanceGroup in the Go SDK.

public static class GetComputeInstanceGroup 
{
    public static Task<GetComputeInstanceGroupResult> InvokeAsync(GetComputeInstanceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetComputeInstanceGroupResult> Invoke(GetComputeInstanceGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetComputeInstanceGroupResult> getComputeInstanceGroup(GetComputeInstanceGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: yandex:index/getComputeInstanceGroup:getComputeInstanceGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

InstanceGroupId string

The ID of a specific instance group.

InstanceGroupId string

The ID of a specific instance group.

instanceGroupId String

The ID of a specific instance group.

instanceGroupId string

The ID of a specific instance group.

instance_group_id str

The ID of a specific instance group.

instanceGroupId String

The ID of a specific instance group.

getComputeInstanceGroup Result

The following output properties are available:

AllocationPolicies List<GetComputeInstanceGroupAllocationPolicy>

The allocation policy of the instance group by zone and region. The structure is documented below.

ApplicationBalancerStates List<GetComputeInstanceGroupApplicationBalancerState>
ApplicationLoadBalancers List<GetComputeInstanceGroupApplicationLoadBalancer>

Application Load balancing (L7) specifications. The structure is documented below.

CreatedAt string

The instance group creation timestamp.

DeletionProtection bool

Flag that protects the instance group from accidental deletion.

DeployPolicies List<GetComputeInstanceGroupDeployPolicy>

The deployment policy of the instance group. The structure is documented below.

Description string

A description of the boot disk.

FolderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

HealthChecks List<GetComputeInstanceGroupHealthCheck>

Health check specification. The structure is documented below.

Id string

The provider-assigned unique ID for this managed resource.

InstanceGroupId string
InstanceTemplates List<GetComputeInstanceGroupInstanceTemplate>

The instance template that the instance group belongs to. The structure is documented below.

Instances List<GetComputeInstanceGroupInstance>

A list of instances in the specified instance group. The structure is documented below.

Labels Dictionary<string, string>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
LoadBalancerStates List<GetComputeInstanceGroupLoadBalancerState>

Information about which entities can be attached to this load balancer. The structure is documented below.

LoadBalancers List<GetComputeInstanceGroupLoadBalancer>

Load balancing specification. The structure is documented below.

MaxCheckingHealthDuration int

Timeout for waiting for the VM to become healthy. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

Name string

The name of the managed instance.

ScalePolicies List<GetComputeInstanceGroupScalePolicy>

The scaling policy of the instance group. The structure is documented below.

ServiceAccountId string

The service account ID for the instance.

Status string

The status of the instance.

Variables Dictionary<string, string>

A set of key/value variables pairs to assign to the instance group.

AllocationPolicies []GetComputeInstanceGroupAllocationPolicy

The allocation policy of the instance group by zone and region. The structure is documented below.

ApplicationBalancerStates []GetComputeInstanceGroupApplicationBalancerState
ApplicationLoadBalancers []GetComputeInstanceGroupApplicationLoadBalancer

Application Load balancing (L7) specifications. The structure is documented below.

CreatedAt string

The instance group creation timestamp.

DeletionProtection bool

Flag that protects the instance group from accidental deletion.

DeployPolicies []GetComputeInstanceGroupDeployPolicy

The deployment policy of the instance group. The structure is documented below.

Description string

A description of the boot disk.

FolderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

HealthChecks []GetComputeInstanceGroupHealthCheck

Health check specification. The structure is documented below.

Id string

The provider-assigned unique ID for this managed resource.

InstanceGroupId string
InstanceTemplates []GetComputeInstanceGroupInstanceTemplate

The instance template that the instance group belongs to. The structure is documented below.

Instances []GetComputeInstanceGroupInstance

A list of instances in the specified instance group. The structure is documented below.

Labels map[string]string

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
LoadBalancerStates []GetComputeInstanceGroupLoadBalancerState

Information about which entities can be attached to this load balancer. The structure is documented below.

LoadBalancers []GetComputeInstanceGroupLoadBalancer

Load balancing specification. The structure is documented below.

MaxCheckingHealthDuration int

Timeout for waiting for the VM to become healthy. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

Name string

The name of the managed instance.

ScalePolicies []GetComputeInstanceGroupScalePolicy

The scaling policy of the instance group. The structure is documented below.

ServiceAccountId string

The service account ID for the instance.

Status string

The status of the instance.

Variables map[string]string

A set of key/value variables pairs to assign to the instance group.

allocationPolicies List<GetComputeInstanceGroupAllocationPolicy>

The allocation policy of the instance group by zone and region. The structure is documented below.

applicationBalancerStates List<GetComputeInstanceGroupApplicationBalancerState>
applicationLoadBalancers List<GetComputeInstanceGroupApplicationLoadBalancer>

Application Load balancing (L7) specifications. The structure is documented below.

createdAt String

The instance group creation timestamp.

deletionProtection Boolean

Flag that protects the instance group from accidental deletion.

deployPolicies List<GetComputeInstanceGroupDeployPolicy>

The deployment policy of the instance group. The structure is documented below.

description String

A description of the boot disk.

folderId String

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

healthChecks List<GetComputeInstanceGroupHealthCheck>

Health check specification. The structure is documented below.

id String

The provider-assigned unique ID for this managed resource.

instanceGroupId String
instanceTemplates List<GetComputeInstanceGroupInstanceTemplate>

The instance template that the instance group belongs to. The structure is documented below.

instances List<GetComputeInstanceGroupInstance>

A list of instances in the specified instance group. The structure is documented below.

labels Map<String,String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
loadBalancerStates List<GetComputeInstanceGroupLoadBalancerState>

Information about which entities can be attached to this load balancer. The structure is documented below.

loadBalancers List<GetComputeInstanceGroupLoadBalancer>

Load balancing specification. The structure is documented below.

maxCheckingHealthDuration Integer

Timeout for waiting for the VM to become healthy. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

name String

The name of the managed instance.

scalePolicies List<GetComputeInstanceGroupScalePolicy>

The scaling policy of the instance group. The structure is documented below.

serviceAccountId String

The service account ID for the instance.

status String

The status of the instance.

variables Map<String,String>

A set of key/value variables pairs to assign to the instance group.

allocationPolicies GetComputeInstanceGroupAllocationPolicy[]

The allocation policy of the instance group by zone and region. The structure is documented below.

applicationBalancerStates GetComputeInstanceGroupApplicationBalancerState[]
applicationLoadBalancers GetComputeInstanceGroupApplicationLoadBalancer[]

Application Load balancing (L7) specifications. The structure is documented below.

createdAt string

The instance group creation timestamp.

deletionProtection boolean

Flag that protects the instance group from accidental deletion.

deployPolicies GetComputeInstanceGroupDeployPolicy[]

The deployment policy of the instance group. The structure is documented below.

description string

A description of the boot disk.

folderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

healthChecks GetComputeInstanceGroupHealthCheck[]

Health check specification. The structure is documented below.

id string

The provider-assigned unique ID for this managed resource.

instanceGroupId string
instanceTemplates GetComputeInstanceGroupInstanceTemplate[]

The instance template that the instance group belongs to. The structure is documented below.

instances GetComputeInstanceGroupInstance[]

A list of instances in the specified instance group. The structure is documented below.

labels {[key: string]: string}

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
loadBalancerStates GetComputeInstanceGroupLoadBalancerState[]

Information about which entities can be attached to this load balancer. The structure is documented below.

loadBalancers GetComputeInstanceGroupLoadBalancer[]

Load balancing specification. The structure is documented below.

maxCheckingHealthDuration number

Timeout for waiting for the VM to become healthy. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

name string

The name of the managed instance.

scalePolicies GetComputeInstanceGroupScalePolicy[]

The scaling policy of the instance group. The structure is documented below.

serviceAccountId string

The service account ID for the instance.

status string

The status of the instance.

variables {[key: string]: string}

A set of key/value variables pairs to assign to the instance group.

allocation_policies Sequence[GetComputeInstanceGroupAllocationPolicy]

The allocation policy of the instance group by zone and region. The structure is documented below.

application_balancer_states Sequence[GetComputeInstanceGroupApplicationBalancerState]
application_load_balancers Sequence[GetComputeInstanceGroupApplicationLoadBalancer]

Application Load balancing (L7) specifications. The structure is documented below.

created_at str

The instance group creation timestamp.

deletion_protection bool

Flag that protects the instance group from accidental deletion.

deploy_policies Sequence[GetComputeInstanceGroupDeployPolicy]

The deployment policy of the instance group. The structure is documented below.

description str

A description of the boot disk.

folder_id str

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

health_checks Sequence[GetComputeInstanceGroupHealthCheck]

Health check specification. The structure is documented below.

id str

The provider-assigned unique ID for this managed resource.

instance_group_id str
instance_templates Sequence[GetComputeInstanceGroupInstanceTemplate]

The instance template that the instance group belongs to. The structure is documented below.

instances Sequence[GetComputeInstanceGroupInstance]

A list of instances in the specified instance group. The structure is documented below.

labels Mapping[str, str]

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
load_balancer_states Sequence[GetComputeInstanceGroupLoadBalancerState]

Information about which entities can be attached to this load balancer. The structure is documented below.

load_balancers Sequence[GetComputeInstanceGroupLoadBalancer]

Load balancing specification. The structure is documented below.

max_checking_health_duration int

Timeout for waiting for the VM to become healthy. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

name str

The name of the managed instance.

scale_policies Sequence[GetComputeInstanceGroupScalePolicy]

The scaling policy of the instance group. The structure is documented below.

service_account_id str

The service account ID for the instance.

status str

The status of the instance.

variables Mapping[str, str]

A set of key/value variables pairs to assign to the instance group.

allocationPolicies List<Property Map>

The allocation policy of the instance group by zone and region. The structure is documented below.

applicationBalancerStates List<Property Map>
applicationLoadBalancers List<Property Map>

Application Load balancing (L7) specifications. The structure is documented below.

createdAt String

The instance group creation timestamp.

deletionProtection Boolean

Flag that protects the instance group from accidental deletion.

deployPolicies List<Property Map>

The deployment policy of the instance group. The structure is documented below.

description String

A description of the boot disk.

folderId String

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

healthChecks List<Property Map>

Health check specification. The structure is documented below.

id String

The provider-assigned unique ID for this managed resource.

instanceGroupId String
instanceTemplates List<Property Map>

The instance template that the instance group belongs to. The structure is documented below.

instances List<Property Map>

A list of instances in the specified instance group. The structure is documented below.

labels Map<String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
loadBalancerStates List<Property Map>

Information about which entities can be attached to this load balancer. The structure is documented below.

loadBalancers List<Property Map>

Load balancing specification. The structure is documented below.

maxCheckingHealthDuration Number

Timeout for waiting for the VM to become healthy. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

name String

The name of the managed instance.

scalePolicies List<Property Map>

The scaling policy of the instance group. The structure is documented below.

serviceAccountId String

The service account ID for the instance.

status String

The status of the instance.

variables Map<String>

A set of key/value variables pairs to assign to the instance group.

Supporting Types

GetComputeInstanceGroupAllocationPolicy

Zones List<string>

A list of availability zones.

Zones []string

A list of availability zones.

zones List<String>

A list of availability zones.

zones string[]

A list of availability zones.

zones Sequence[str]

A list of availability zones.

zones List<String>

A list of availability zones.

GetComputeInstanceGroupApplicationBalancerState

StatusMessage string

The status message of the target group.

TargetGroupId string

The ID of the target group.

StatusMessage string

The status message of the target group.

TargetGroupId string

The ID of the target group.

statusMessage String

The status message of the target group.

targetGroupId String

The ID of the target group.

statusMessage string

The status message of the target group.

targetGroupId string

The ID of the target group.

status_message str

The status message of the target group.

target_group_id str

The ID of the target group.

statusMessage String

The status message of the target group.

targetGroupId String

The ID of the target group.

GetComputeInstanceGroupApplicationLoadBalancer

MaxOpeningTrafficDuration int

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

StatusMessage string

The status message of the target group.

TargetGroupDescription string

A description of the target group.

TargetGroupId string

The ID of the target group.

TargetGroupLabels Dictionary<string, string>

A set of key/value label pairs.

TargetGroupName string

The name of the target group.

MaxOpeningTrafficDuration int

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

StatusMessage string

The status message of the target group.

TargetGroupDescription string

A description of the target group.

TargetGroupId string

The ID of the target group.

TargetGroupLabels map[string]string

A set of key/value label pairs.

TargetGroupName string

The name of the target group.

maxOpeningTrafficDuration Integer

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

statusMessage String

The status message of the target group.

targetGroupDescription String

A description of the target group.

targetGroupId String

The ID of the target group.

targetGroupLabels Map<String,String>

A set of key/value label pairs.

targetGroupName String

The name of the target group.

maxOpeningTrafficDuration number

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

statusMessage string

The status message of the target group.

targetGroupDescription string

A description of the target group.

targetGroupId string

The ID of the target group.

targetGroupLabels {[key: string]: string}

A set of key/value label pairs.

targetGroupName string

The name of the target group.

max_opening_traffic_duration int

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

status_message str

The status message of the target group.

target_group_description str

A description of the target group.

target_group_id str

The ID of the target group.

target_group_labels Mapping[str, str]

A set of key/value label pairs.

target_group_name str

The name of the target group.

maxOpeningTrafficDuration Number

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

statusMessage String

The status message of the target group.

targetGroupDescription String

A description of the target group.

targetGroupId String

The ID of the target group.

targetGroupLabels Map<String>

A set of key/value label pairs.

targetGroupName String

The name of the target group.

GetComputeInstanceGroupDeployPolicy

MaxCreating int

The maximum number of instances that can be created at the same time.

MaxDeleting int

The maximum number of instances that can be deleted at the same time.

MaxExpansion int

The maximum number of instances that can be temporarily allocated above the group's target size during the update process.

MaxUnavailable int

The maximum number of running instances that can be taken offline (stopped or deleted) at the same time during the update process.

StartupDuration int

The amount of time in seconds to allow for an instance to start.

Strategy string

Affects the lifecycle of the instance during deployment. If set to proactive (default), Instance Groups can forcefully stop a running instance. If opportunistic, Instance Groups does not stop a running instance. Instead, it will wait until the instance stops itself or becomes unhealthy.

MaxCreating int

The maximum number of instances that can be created at the same time.

MaxDeleting int

The maximum number of instances that can be deleted at the same time.

MaxExpansion int

The maximum number of instances that can be temporarily allocated above the group's target size during the update process.

MaxUnavailable int

The maximum number of running instances that can be taken offline (stopped or deleted) at the same time during the update process.

StartupDuration int

The amount of time in seconds to allow for an instance to start.

Strategy string

Affects the lifecycle of the instance during deployment. If set to proactive (default), Instance Groups can forcefully stop a running instance. If opportunistic, Instance Groups does not stop a running instance. Instead, it will wait until the instance stops itself or becomes unhealthy.

maxCreating Integer

The maximum number of instances that can be created at the same time.

maxDeleting Integer

The maximum number of instances that can be deleted at the same time.

maxExpansion Integer

The maximum number of instances that can be temporarily allocated above the group's target size during the update process.

maxUnavailable Integer

The maximum number of running instances that can be taken offline (stopped or deleted) at the same time during the update process.

startupDuration Integer

The amount of time in seconds to allow for an instance to start.

strategy String

Affects the lifecycle of the instance during deployment. If set to proactive (default), Instance Groups can forcefully stop a running instance. If opportunistic, Instance Groups does not stop a running instance. Instead, it will wait until the instance stops itself or becomes unhealthy.

maxCreating number

The maximum number of instances that can be created at the same time.

maxDeleting number

The maximum number of instances that can be deleted at the same time.

maxExpansion number

The maximum number of instances that can be temporarily allocated above the group's target size during the update process.

maxUnavailable number

The maximum number of running instances that can be taken offline (stopped or deleted) at the same time during the update process.

startupDuration number

The amount of time in seconds to allow for an instance to start.

strategy string

Affects the lifecycle of the instance during deployment. If set to proactive (default), Instance Groups can forcefully stop a running instance. If opportunistic, Instance Groups does not stop a running instance. Instead, it will wait until the instance stops itself or becomes unhealthy.

max_creating int

The maximum number of instances that can be created at the same time.

max_deleting int

The maximum number of instances that can be deleted at the same time.

max_expansion int

The maximum number of instances that can be temporarily allocated above the group's target size during the update process.

max_unavailable int

The maximum number of running instances that can be taken offline (stopped or deleted) at the same time during the update process.

startup_duration int

The amount of time in seconds to allow for an instance to start.

strategy str

Affects the lifecycle of the instance during deployment. If set to proactive (default), Instance Groups can forcefully stop a running instance. If opportunistic, Instance Groups does not stop a running instance. Instead, it will wait until the instance stops itself or becomes unhealthy.

maxCreating Number

The maximum number of instances that can be created at the same time.

maxDeleting Number

The maximum number of instances that can be deleted at the same time.

maxExpansion Number

The maximum number of instances that can be temporarily allocated above the group's target size during the update process.

maxUnavailable Number

The maximum number of running instances that can be taken offline (stopped or deleted) at the same time during the update process.

startupDuration Number

The amount of time in seconds to allow for an instance to start.

strategy String

Affects the lifecycle of the instance during deployment. If set to proactive (default), Instance Groups can forcefully stop a running instance. If opportunistic, Instance Groups does not stop a running instance. Instead, it will wait until the instance stops itself or becomes unhealthy.

GetComputeInstanceGroupHealthCheck

HealthyThreshold int

The number of successful health checks before the managed instance is declared healthy.

HttpOptions List<GetComputeInstanceGroupHealthCheckHttpOption>

HTTP check options. The structure is documented below.

Interval int

The interval between health checks in seconds.

TcpOptions List<GetComputeInstanceGroupHealthCheckTcpOption>

TCP check options. The structure is documented below.

Timeout int

Timeout for the managed instance to return a response for the health check in seconds.

UnhealthyThreshold int

The number of failed health checks before the managed instance is declared unhealthy.

HealthyThreshold int

The number of successful health checks before the managed instance is declared healthy.

HttpOptions []GetComputeInstanceGroupHealthCheckHttpOption

HTTP check options. The structure is documented below.

Interval int

The interval between health checks in seconds.

TcpOptions []GetComputeInstanceGroupHealthCheckTcpOption

TCP check options. The structure is documented below.

Timeout int

Timeout for the managed instance to return a response for the health check in seconds.

UnhealthyThreshold int

The number of failed health checks before the managed instance is declared unhealthy.

healthyThreshold Integer

The number of successful health checks before the managed instance is declared healthy.

httpOptions List<GetComputeInstanceGroupHealthCheckHttpOption>

HTTP check options. The structure is documented below.

interval Integer

The interval between health checks in seconds.

tcpOptions List<GetComputeInstanceGroupHealthCheckTcpOption>

TCP check options. The structure is documented below.

timeout Integer

Timeout for the managed instance to return a response for the health check in seconds.

unhealthyThreshold Integer

The number of failed health checks before the managed instance is declared unhealthy.

healthyThreshold number

The number of successful health checks before the managed instance is declared healthy.

httpOptions GetComputeInstanceGroupHealthCheckHttpOption[]

HTTP check options. The structure is documented below.

interval number

The interval between health checks in seconds.

tcpOptions GetComputeInstanceGroupHealthCheckTcpOption[]

TCP check options. The structure is documented below.

timeout number

Timeout for the managed instance to return a response for the health check in seconds.

unhealthyThreshold number

The number of failed health checks before the managed instance is declared unhealthy.

healthy_threshold int

The number of successful health checks before the managed instance is declared healthy.

http_options Sequence[GetComputeInstanceGroupHealthCheckHttpOption]

HTTP check options. The structure is documented below.

interval int

The interval between health checks in seconds.

tcp_options Sequence[GetComputeInstanceGroupHealthCheckTcpOption]

TCP check options. The structure is documented below.

timeout int

Timeout for the managed instance to return a response for the health check in seconds.

unhealthy_threshold int

The number of failed health checks before the managed instance is declared unhealthy.

healthyThreshold Number

The number of successful health checks before the managed instance is declared healthy.

httpOptions List<Property Map>

HTTP check options. The structure is documented below.

interval Number

The interval between health checks in seconds.

tcpOptions List<Property Map>

TCP check options. The structure is documented below.

timeout Number

Timeout for the managed instance to return a response for the health check in seconds.

unhealthyThreshold Number

The number of failed health checks before the managed instance is declared unhealthy.

GetComputeInstanceGroupHealthCheckHttpOption

Path string

The URL path used for health check requests.

Port int

The port to use for TCP health checks.

Path string

The URL path used for health check requests.

Port int

The port to use for TCP health checks.

path String

The URL path used for health check requests.

port Integer

The port to use for TCP health checks.

path string

The URL path used for health check requests.

port number

The port to use for TCP health checks.

path str

The URL path used for health check requests.

port int

The port to use for TCP health checks.

path String

The URL path used for health check requests.

port Number

The port to use for TCP health checks.

GetComputeInstanceGroupHealthCheckTcpOption

Port int

The port to use for TCP health checks.

Port int

The port to use for TCP health checks.

port Integer

The port to use for TCP health checks.

port number

The port to use for TCP health checks.

port int

The port to use for TCP health checks.

port Number

The port to use for TCP health checks.

GetComputeInstanceGroupInstance

Fqdn string

The Fully Qualified Domain Name.

InstanceId string

The ID of the instance.

Name string

The name of the managed instance.

NetworkInterfaces List<GetComputeInstanceGroupInstanceNetworkInterface>

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
Status string

The status of the instance.

StatusChangedAt string
StatusMessage string

The status message of the target group.

ZoneId string

The ID of the availability zone where the instance resides.

Fqdn string

The Fully Qualified Domain Name.

InstanceId string

The ID of the instance.

Name string

The name of the managed instance.

NetworkInterfaces []GetComputeInstanceGroupInstanceNetworkInterface

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
Status string

The status of the instance.

StatusChangedAt string
StatusMessage string

The status message of the target group.

ZoneId string

The ID of the availability zone where the instance resides.

fqdn String

The Fully Qualified Domain Name.

instanceId String

The ID of the instance.

name String

The name of the managed instance.

networkInterfaces List<GetComputeInstanceGroupInstanceNetworkInterface>

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
status String

The status of the instance.

statusChangedAt String
statusMessage String

The status message of the target group.

zoneId String

The ID of the availability zone where the instance resides.

fqdn string

The Fully Qualified Domain Name.

instanceId string

The ID of the instance.

name string

The name of the managed instance.

networkInterfaces GetComputeInstanceGroupInstanceNetworkInterface[]

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
status string

The status of the instance.

statusChangedAt string
statusMessage string

The status message of the target group.

zoneId string

The ID of the availability zone where the instance resides.

fqdn str

The Fully Qualified Domain Name.

instance_id str

The ID of the instance.

name str

The name of the managed instance.

network_interfaces Sequence[GetComputeInstanceGroupInstanceNetworkInterface]

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
status str

The status of the instance.

status_changed_at str
status_message str

The status message of the target group.

zone_id str

The ID of the availability zone where the instance resides.

fqdn String

The Fully Qualified Domain Name.

instanceId String

The ID of the instance.

name String

The name of the managed instance.

networkInterfaces List<Property Map>

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
status String

The status of the instance.

statusChangedAt String
statusMessage String

The status message of the target group.

zoneId String

The ID of the availability zone where the instance resides.

GetComputeInstanceGroupInstanceNetworkInterface

Index int

The index of the network interface as generated by the server.

IpAddress string

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

Ipv4 bool

Is IPv4 address assigned.

Ipv6 bool
Ipv6Address string

Manual set static IPv6 address.

MacAddress string

The MAC address assigned to the network interface.

Nat bool

The instance's public address for accessing the internet over NAT.

NatIpAddress string

The public IP address of the instance.

NatIpVersion string

The IP version for the public address.

SubnetId string

The ID of the subnet to attach this interface to. The subnet must reside in the same zone where this instance was created.

Index int

The index of the network interface as generated by the server.

IpAddress string

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

Ipv4 bool

Is IPv4 address assigned.

Ipv6 bool
Ipv6Address string

Manual set static IPv6 address.

MacAddress string

The MAC address assigned to the network interface.

Nat bool

The instance's public address for accessing the internet over NAT.

NatIpAddress string

The public IP address of the instance.

NatIpVersion string

The IP version for the public address.

SubnetId string

The ID of the subnet to attach this interface to. The subnet must reside in the same zone where this instance was created.

index Integer

The index of the network interface as generated by the server.

ipAddress String

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 Boolean

Is IPv4 address assigned.

ipv6 Boolean
ipv6Address String

Manual set static IPv6 address.

macAddress String

The MAC address assigned to the network interface.

nat Boolean

The instance's public address for accessing the internet over NAT.

natIpAddress String

The public IP address of the instance.

natIpVersion String

The IP version for the public address.

subnetId String

The ID of the subnet to attach this interface to. The subnet must reside in the same zone where this instance was created.

index number

The index of the network interface as generated by the server.

ipAddress string

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 boolean

Is IPv4 address assigned.

ipv6 boolean
ipv6Address string

Manual set static IPv6 address.

macAddress string

The MAC address assigned to the network interface.

nat boolean

The instance's public address for accessing the internet over NAT.

natIpAddress string

The public IP address of the instance.

natIpVersion string

The IP version for the public address.

subnetId string

The ID of the subnet to attach this interface to. The subnet must reside in the same zone where this instance was created.

index int

The index of the network interface as generated by the server.

ip_address str

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 bool

Is IPv4 address assigned.

ipv6 bool
ipv6_address str

Manual set static IPv6 address.

mac_address str

The MAC address assigned to the network interface.

nat bool

The instance's public address for accessing the internet over NAT.

nat_ip_address str

The public IP address of the instance.

nat_ip_version str

The IP version for the public address.

subnet_id str

The ID of the subnet to attach this interface to. The subnet must reside in the same zone where this instance was created.

index Number

The index of the network interface as generated by the server.

ipAddress String

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 Boolean

Is IPv4 address assigned.

ipv6 Boolean
ipv6Address String

Manual set static IPv6 address.

macAddress String

The MAC address assigned to the network interface.

nat Boolean

The instance's public address for accessing the internet over NAT.

natIpAddress String

The public IP address of the instance.

natIpVersion String

The IP version for the public address.

subnetId String

The ID of the subnet to attach this interface to. The subnet must reside in the same zone where this instance was created.

GetComputeInstanceGroupInstanceTemplate

BootDisks List<GetComputeInstanceGroupInstanceTemplateBootDisk>

The specifications for boot disk that will be attached to the instance. The structure is documented below.

Description string

A description of the boot disk.

Hostname string

Hostname temaplate for the instance.

Labels Dictionary<string, string>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
Metadata Dictionary<string, string>

The set of metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.

Name string

The name of the managed instance.

NetworkInterfaces List<GetComputeInstanceGroupInstanceTemplateNetworkInterface>

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
NetworkSettings List<GetComputeInstanceGroupInstanceTemplateNetworkSetting>

Network acceleration settings. The structure is documented below.

PlatformId string

The ID of the hardware platform configuration for the instance.

Resources List<GetComputeInstanceGroupInstanceTemplateResource>
SchedulingPolicies List<GetComputeInstanceGroupInstanceTemplateSchedulingPolicy>

The scheduling policy for the instance. The structure is documented below.

SecondaryDisks List<GetComputeInstanceGroupInstanceTemplateSecondaryDisk>

An array with the secondary disks that will be attached to the instance. The structure is documented below.

ServiceAccountId string

The service account ID for the instance.

PlacementPolicy GetComputeInstanceGroupInstanceTemplatePlacementPolicy
BootDisks []GetComputeInstanceGroupInstanceTemplateBootDisk

The specifications for boot disk that will be attached to the instance. The structure is documented below.

Description string

A description of the boot disk.

Hostname string

Hostname temaplate for the instance.

Labels map[string]string

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
Metadata map[string]string

The set of metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.

Name string

The name of the managed instance.

NetworkInterfaces []GetComputeInstanceGroupInstanceTemplateNetworkInterface

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
NetworkSettings []GetComputeInstanceGroupInstanceTemplateNetworkSetting

Network acceleration settings. The structure is documented below.

PlatformId string

The ID of the hardware platform configuration for the instance.

Resources []GetComputeInstanceGroupInstanceTemplateResource
SchedulingPolicies []GetComputeInstanceGroupInstanceTemplateSchedulingPolicy

The scheduling policy for the instance. The structure is documented below.

SecondaryDisks []GetComputeInstanceGroupInstanceTemplateSecondaryDisk

An array with the secondary disks that will be attached to the instance. The structure is documented below.

ServiceAccountId string

The service account ID for the instance.

PlacementPolicy GetComputeInstanceGroupInstanceTemplatePlacementPolicy
bootDisks List<GetComputeInstanceGroupInstanceTemplateBootDisk>

The specifications for boot disk that will be attached to the instance. The structure is documented below.

description String

A description of the boot disk.

hostname String

Hostname temaplate for the instance.

labels Map<String,String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metadata Map<String,String>

The set of metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.

name String

The name of the managed instance.

networkInterfaces List<GetComputeInstanceGroupInstanceTemplateNetworkInterface>

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
networkSettings List<GetComputeInstanceGroupInstanceTemplateNetworkSetting>

Network acceleration settings. The structure is documented below.

platformId String

The ID of the hardware platform configuration for the instance.

resources List<GetComputeInstanceGroupInstanceTemplateResource>
schedulingPolicies List<GetComputeInstanceGroupInstanceTemplateSchedulingPolicy>

The scheduling policy for the instance. The structure is documented below.

secondaryDisks List<GetComputeInstanceGroupInstanceTemplateSecondaryDisk>

An array with the secondary disks that will be attached to the instance. The structure is documented below.

serviceAccountId String

The service account ID for the instance.

placementPolicy GetComputeInstanceGroupInstanceTemplatePlacementPolicy
bootDisks GetComputeInstanceGroupInstanceTemplateBootDisk[]

The specifications for boot disk that will be attached to the instance. The structure is documented below.

description string

A description of the boot disk.

hostname string

Hostname temaplate for the instance.

labels {[key: string]: string}

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metadata {[key: string]: string}

The set of metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.

name string

The name of the managed instance.

networkInterfaces GetComputeInstanceGroupInstanceTemplateNetworkInterface[]

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
networkSettings GetComputeInstanceGroupInstanceTemplateNetworkSetting[]

Network acceleration settings. The structure is documented below.

platformId string

The ID of the hardware platform configuration for the instance.

resources GetComputeInstanceGroupInstanceTemplateResource[]
schedulingPolicies GetComputeInstanceGroupInstanceTemplateSchedulingPolicy[]

The scheduling policy for the instance. The structure is documented below.

secondaryDisks GetComputeInstanceGroupInstanceTemplateSecondaryDisk[]

An array with the secondary disks that will be attached to the instance. The structure is documented below.

serviceAccountId string

The service account ID for the instance.

placementPolicy GetComputeInstanceGroupInstanceTemplatePlacementPolicy
boot_disks Sequence[GetComputeInstanceGroupInstanceTemplateBootDisk]

The specifications for boot disk that will be attached to the instance. The structure is documented below.

description str

A description of the boot disk.

hostname str

Hostname temaplate for the instance.

labels Mapping[str, str]

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metadata Mapping[str, str]

The set of metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.

name str

The name of the managed instance.

network_interfaces Sequence[GetComputeInstanceGroupInstanceTemplateNetworkInterface]

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
network_settings Sequence[GetComputeInstanceGroupInstanceTemplateNetworkSetting]

Network acceleration settings. The structure is documented below.

platform_id str

The ID of the hardware platform configuration for the instance.

resources Sequence[GetComputeInstanceGroupInstanceTemplateResource]
scheduling_policies Sequence[GetComputeInstanceGroupInstanceTemplateSchedulingPolicy]

The scheduling policy for the instance. The structure is documented below.

secondary_disks Sequence[GetComputeInstanceGroupInstanceTemplateSecondaryDisk]

An array with the secondary disks that will be attached to the instance. The structure is documented below.

service_account_id str

The service account ID for the instance.

placement_policy GetComputeInstanceGroupInstanceTemplatePlacementPolicy
bootDisks List<Property Map>

The specifications for boot disk that will be attached to the instance. The structure is documented below.

description String

A description of the boot disk.

hostname String

Hostname temaplate for the instance.

labels Map<String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metadata Map<String>

The set of metadata key:value pairs assigned to this instance template. This includes custom metadata and predefined keys.

name String

The name of the managed instance.

networkInterfaces List<Property Map>

An array with the network interfaces attached to the managed instance. The structure is documented below.

  • status_changed_at -The timestamp when the status of the managed instance was last changed.
networkSettings List<Property Map>

Network acceleration settings. The structure is documented below.

platformId String

The ID of the hardware platform configuration for the instance.

resources List<Property Map>
schedulingPolicies List<Property Map>

The scheduling policy for the instance. The structure is documented below.

secondaryDisks List<Property Map>

An array with the secondary disks that will be attached to the instance. The structure is documented below.

serviceAccountId String

The service account ID for the instance.

placementPolicy Property Map

GetComputeInstanceGroupInstanceTemplateBootDisk

DeviceName string

This value can be used to reference the device under /dev/disk/by-id/.

DiskId string

ID of the existing disk. To set use variables.

InitializeParams List<GetComputeInstanceGroupInstanceTemplateBootDiskInitializeParam>

The parameters used for creating a disk alongside the instance. The structure is documented below.

Mode string

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

DeviceName string

This value can be used to reference the device under /dev/disk/by-id/.

DiskId string

ID of the existing disk. To set use variables.

InitializeParams []GetComputeInstanceGroupInstanceTemplateBootDiskInitializeParam

The parameters used for creating a disk alongside the instance. The structure is documented below.

Mode string

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

deviceName String

This value can be used to reference the device under /dev/disk/by-id/.

diskId String

ID of the existing disk. To set use variables.

initializeParams List<GetComputeInstanceGroupInstanceTemplateBootDiskInitializeParam>

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode String

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

deviceName string

This value can be used to reference the device under /dev/disk/by-id/.

diskId string

ID of the existing disk. To set use variables.

initializeParams GetComputeInstanceGroupInstanceTemplateBootDiskInitializeParam[]

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode string

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

device_name str

This value can be used to reference the device under /dev/disk/by-id/.

disk_id str

ID of the existing disk. To set use variables.

initialize_params Sequence[GetComputeInstanceGroupInstanceTemplateBootDiskInitializeParam]

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode str

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

deviceName String

This value can be used to reference the device under /dev/disk/by-id/.

diskId String

ID of the existing disk. To set use variables.

initializeParams List<Property Map>

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode String

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

GetComputeInstanceGroupInstanceTemplateBootDiskInitializeParam

Description string

A description of the boot disk.

ImageId string

The disk image to initialize this disk from.

Size int

The size of the disk in GB.

SnapshotId string

The snapshot to initialize this disk from.

Type string

Network acceleration type. By default a network is in STANDARD mode.

Description string

A description of the boot disk.

ImageId string

The disk image to initialize this disk from.

Size int

The size of the disk in GB.

SnapshotId string

The snapshot to initialize this disk from.

Type string

Network acceleration type. By default a network is in STANDARD mode.

description String

A description of the boot disk.

imageId String

The disk image to initialize this disk from.

size Integer

The size of the disk in GB.

snapshotId String

The snapshot to initialize this disk from.

type String

Network acceleration type. By default a network is in STANDARD mode.

description string

A description of the boot disk.

imageId string

The disk image to initialize this disk from.

size number

The size of the disk in GB.

snapshotId string

The snapshot to initialize this disk from.

type string

Network acceleration type. By default a network is in STANDARD mode.

description str

A description of the boot disk.

image_id str

The disk image to initialize this disk from.

size int

The size of the disk in GB.

snapshot_id str

The snapshot to initialize this disk from.

type str

Network acceleration type. By default a network is in STANDARD mode.

description String

A description of the boot disk.

imageId String

The disk image to initialize this disk from.

size Number

The size of the disk in GB.

snapshotId String

The snapshot to initialize this disk from.

type String

Network acceleration type. By default a network is in STANDARD mode.

GetComputeInstanceGroupInstanceTemplateNetworkInterface

DnsRecords List<GetComputeInstanceGroupInstanceTemplateNetworkInterfaceDnsRecord>

List of dns records. The structure is documented below.

IpAddress string

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

Ipv4 bool

Is IPv4 address assigned.

Ipv6 bool
Ipv6Address string

Manual set static IPv6 address.

Ipv6DnsRecords List<GetComputeInstanceGroupInstanceTemplateNetworkInterfaceIpv6DnsRecord>

List of ipv6 dns records. The structure is documented below.

Nat bool

The instance's public address for accessing the internet over NAT.

NatDnsRecords List<GetComputeInstanceGroupInstanceTemplateNetworkInterfaceNatDnsRecord>

List of nat dns records. The structure is documented below.

NatIpAddress string

The public IP address of the instance.

NetworkId string

The ID of the network.

SecurityGroupIds List<string>

Security group ids for network interface.

SubnetIds List<string>

The IDs of the subnets.

DnsRecords []GetComputeInstanceGroupInstanceTemplateNetworkInterfaceDnsRecord

List of dns records. The structure is documented below.

IpAddress string

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

Ipv4 bool

Is IPv4 address assigned.

Ipv6 bool
Ipv6Address string

Manual set static IPv6 address.

Ipv6DnsRecords []GetComputeInstanceGroupInstanceTemplateNetworkInterfaceIpv6DnsRecord

List of ipv6 dns records. The structure is documented below.

Nat bool

The instance's public address for accessing the internet over NAT.

NatDnsRecords []GetComputeInstanceGroupInstanceTemplateNetworkInterfaceNatDnsRecord

List of nat dns records. The structure is documented below.

NatIpAddress string

The public IP address of the instance.

NetworkId string

The ID of the network.

SecurityGroupIds []string

Security group ids for network interface.

SubnetIds []string

The IDs of the subnets.

dnsRecords List<GetComputeInstanceGroupInstanceTemplateNetworkInterfaceDnsRecord>

List of dns records. The structure is documented below.

ipAddress String

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 Boolean

Is IPv4 address assigned.

ipv6 Boolean
ipv6Address String

Manual set static IPv6 address.

ipv6DnsRecords List<GetComputeInstanceGroupInstanceTemplateNetworkInterfaceIpv6DnsRecord>

List of ipv6 dns records. The structure is documented below.

nat Boolean

The instance's public address for accessing the internet over NAT.

natDnsRecords List<GetComputeInstanceGroupInstanceTemplateNetworkInterfaceNatDnsRecord>

List of nat dns records. The structure is documented below.

natIpAddress String

The public IP address of the instance.

networkId String

The ID of the network.

securityGroupIds List<String>

Security group ids for network interface.

subnetIds List<String>

The IDs of the subnets.

dnsRecords GetComputeInstanceGroupInstanceTemplateNetworkInterfaceDnsRecord[]

List of dns records. The structure is documented below.

ipAddress string

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 boolean

Is IPv4 address assigned.

ipv6 boolean
ipv6Address string

Manual set static IPv6 address.

ipv6DnsRecords GetComputeInstanceGroupInstanceTemplateNetworkInterfaceIpv6DnsRecord[]

List of ipv6 dns records. The structure is documented below.

nat boolean

The instance's public address for accessing the internet over NAT.

natDnsRecords GetComputeInstanceGroupInstanceTemplateNetworkInterfaceNatDnsRecord[]

List of nat dns records. The structure is documented below.

natIpAddress string

The public IP address of the instance.

networkId string

The ID of the network.

securityGroupIds string[]

Security group ids for network interface.

subnetIds string[]

The IDs of the subnets.

dns_records Sequence[GetComputeInstanceGroupInstanceTemplateNetworkInterfaceDnsRecord]

List of dns records. The structure is documented below.

ip_address str

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 bool

Is IPv4 address assigned.

ipv6 bool
ipv6_address str

Manual set static IPv6 address.

ipv6_dns_records Sequence[GetComputeInstanceGroupInstanceTemplateNetworkInterfaceIpv6DnsRecord]

List of ipv6 dns records. The structure is documented below.

nat bool

The instance's public address for accessing the internet over NAT.

nat_dns_records Sequence[GetComputeInstanceGroupInstanceTemplateNetworkInterfaceNatDnsRecord]

List of nat dns records. The structure is documented below.

nat_ip_address str

The public IP address of the instance.

network_id str

The ID of the network.

security_group_ids Sequence[str]

Security group ids for network interface.

subnet_ids Sequence[str]

The IDs of the subnets.

dnsRecords List<Property Map>

List of dns records. The structure is documented below.

ipAddress String

The private IP address to assign to the instance. If empty, the address is automatically assigned from the specified subnet.

ipv4 Boolean

Is IPv4 address assigned.

ipv6 Boolean
ipv6Address String

Manual set static IPv6 address.

ipv6DnsRecords List<Property Map>

List of ipv6 dns records. The structure is documented below.

nat Boolean

The instance's public address for accessing the internet over NAT.

natDnsRecords List<Property Map>

List of nat dns records. The structure is documented below.

natIpAddress String

The public IP address of the instance.

networkId String

The ID of the network.

securityGroupIds List<String>

Security group ids for network interface.

subnetIds List<String>

The IDs of the subnets.

GetComputeInstanceGroupInstanceTemplateNetworkInterfaceDnsRecord

DnsZoneId string

DNS zone id (if not set, private zone is used).

Fqdn string

The Fully Qualified Domain Name.

Ptr bool

When set to true, also create PTR DNS record.

Ttl int

DNS record TTL.

DnsZoneId string

DNS zone id (if not set, private zone is used).

Fqdn string

The Fully Qualified Domain Name.

Ptr bool

When set to true, also create PTR DNS record.

Ttl int

DNS record TTL.

dnsZoneId String

DNS zone id (if not set, private zone is used).

fqdn String

The Fully Qualified Domain Name.

ptr Boolean

When set to true, also create PTR DNS record.

ttl Integer

DNS record TTL.

dnsZoneId string

DNS zone id (if not set, private zone is used).

fqdn string

The Fully Qualified Domain Name.

ptr boolean

When set to true, also create PTR DNS record.

ttl number

DNS record TTL.

dns_zone_id str

DNS zone id (if not set, private zone is used).

fqdn str

The Fully Qualified Domain Name.

ptr bool

When set to true, also create PTR DNS record.

ttl int

DNS record TTL.

dnsZoneId String

DNS zone id (if not set, private zone is used).

fqdn String

The Fully Qualified Domain Name.

ptr Boolean

When set to true, also create PTR DNS record.

ttl Number

DNS record TTL.

GetComputeInstanceGroupInstanceTemplateNetworkInterfaceIpv6DnsRecord

DnsZoneId string

DNS zone id (if not set, private zone is used).

Fqdn string

The Fully Qualified Domain Name.

Ptr bool

When set to true, also create PTR DNS record.

Ttl int

DNS record TTL.

DnsZoneId string

DNS zone id (if not set, private zone is used).

Fqdn string

The Fully Qualified Domain Name.

Ptr bool

When set to true, also create PTR DNS record.

Ttl int

DNS record TTL.

dnsZoneId String

DNS zone id (if not set, private zone is used).

fqdn String

The Fully Qualified Domain Name.

ptr Boolean

When set to true, also create PTR DNS record.

ttl Integer

DNS record TTL.

dnsZoneId string

DNS zone id (if not set, private zone is used).

fqdn string

The Fully Qualified Domain Name.

ptr boolean

When set to true, also create PTR DNS record.

ttl number

DNS record TTL.

dns_zone_id str

DNS zone id (if not set, private zone is used).

fqdn str

The Fully Qualified Domain Name.

ptr bool

When set to true, also create PTR DNS record.

ttl int

DNS record TTL.

dnsZoneId String

DNS zone id (if not set, private zone is used).

fqdn String

The Fully Qualified Domain Name.

ptr Boolean

When set to true, also create PTR DNS record.

ttl Number

DNS record TTL.

GetComputeInstanceGroupInstanceTemplateNetworkInterfaceNatDnsRecord

DnsZoneId string

DNS zone id (if not set, private zone is used).

Fqdn string

The Fully Qualified Domain Name.

Ptr bool

When set to true, also create PTR DNS record.

Ttl int

DNS record TTL.

DnsZoneId string

DNS zone id (if not set, private zone is used).

Fqdn string

The Fully Qualified Domain Name.

Ptr bool

When set to true, also create PTR DNS record.

Ttl int

DNS record TTL.

dnsZoneId String

DNS zone id (if not set, private zone is used).

fqdn String

The Fully Qualified Domain Name.

ptr Boolean

When set to true, also create PTR DNS record.

ttl Integer

DNS record TTL.

dnsZoneId string

DNS zone id (if not set, private zone is used).

fqdn string

The Fully Qualified Domain Name.

ptr boolean

When set to true, also create PTR DNS record.

ttl number

DNS record TTL.

dns_zone_id str

DNS zone id (if not set, private zone is used).

fqdn str

The Fully Qualified Domain Name.

ptr bool

When set to true, also create PTR DNS record.

ttl int

DNS record TTL.

dnsZoneId String

DNS zone id (if not set, private zone is used).

fqdn String

The Fully Qualified Domain Name.

ptr Boolean

When set to true, also create PTR DNS record.

ttl Number

DNS record TTL.

GetComputeInstanceGroupInstanceTemplateNetworkSetting

Type string

Network acceleration type. By default a network is in STANDARD mode.

Type string

Network acceleration type. By default a network is in STANDARD mode.

type String

Network acceleration type. By default a network is in STANDARD mode.

type string

Network acceleration type. By default a network is in STANDARD mode.

type str

Network acceleration type. By default a network is in STANDARD mode.

type String

Network acceleration type. By default a network is in STANDARD mode.

GetComputeInstanceGroupInstanceTemplatePlacementPolicy

GetComputeInstanceGroupInstanceTemplateResource

CoreFraction int
Cores int
Gpus int
Memory double
CoreFraction int
Cores int
Gpus int
Memory float64
coreFraction Integer
cores Integer
gpus Integer
memory Double
coreFraction number
cores number
gpus number
memory number
coreFraction Number
cores Number
gpus Number
memory Number

GetComputeInstanceGroupInstanceTemplateSchedulingPolicy

Preemptible bool

Specifies if the instance is preemptible. Defaults to false.

Preemptible bool

Specifies if the instance is preemptible. Defaults to false.

preemptible Boolean

Specifies if the instance is preemptible. Defaults to false.

preemptible boolean

Specifies if the instance is preemptible. Defaults to false.

preemptible bool

Specifies if the instance is preemptible. Defaults to false.

preemptible Boolean

Specifies if the instance is preemptible. Defaults to false.

GetComputeInstanceGroupInstanceTemplateSecondaryDisk

DeviceName string

This value can be used to reference the device under /dev/disk/by-id/.

DiskId string

ID of the existing disk. To set use variables.

InitializeParams List<GetComputeInstanceGroupInstanceTemplateSecondaryDiskInitializeParam>

The parameters used for creating a disk alongside the instance. The structure is documented below.

Mode string

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

DeviceName string

This value can be used to reference the device under /dev/disk/by-id/.

DiskId string

ID of the existing disk. To set use variables.

InitializeParams []GetComputeInstanceGroupInstanceTemplateSecondaryDiskInitializeParam

The parameters used for creating a disk alongside the instance. The structure is documented below.

Mode string

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

deviceName String

This value can be used to reference the device under /dev/disk/by-id/.

diskId String

ID of the existing disk. To set use variables.

initializeParams List<GetComputeInstanceGroupInstanceTemplateSecondaryDiskInitializeParam>

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode String

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

deviceName string

This value can be used to reference the device under /dev/disk/by-id/.

diskId string

ID of the existing disk. To set use variables.

initializeParams GetComputeInstanceGroupInstanceTemplateSecondaryDiskInitializeParam[]

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode string

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

device_name str

This value can be used to reference the device under /dev/disk/by-id/.

disk_id str

ID of the existing disk. To set use variables.

initialize_params Sequence[GetComputeInstanceGroupInstanceTemplateSecondaryDiskInitializeParam]

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode str

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

deviceName String

This value can be used to reference the device under /dev/disk/by-id/.

diskId String

ID of the existing disk. To set use variables.

initializeParams List<Property Map>

The parameters used for creating a disk alongside the instance. The structure is documented below.

mode String

The access mode to the disk resource. By default a disk is attached in READ_WRITE mode.

GetComputeInstanceGroupInstanceTemplateSecondaryDiskInitializeParam

Description string

A description of the boot disk.

ImageId string

The disk image to initialize this disk from.

Size int

The size of the disk in GB.

SnapshotId string

The snapshot to initialize this disk from.

Type string

Network acceleration type. By default a network is in STANDARD mode.

Description string

A description of the boot disk.

ImageId string

The disk image to initialize this disk from.

Size int

The size of the disk in GB.

SnapshotId string

The snapshot to initialize this disk from.

Type string

Network acceleration type. By default a network is in STANDARD mode.

description String

A description of the boot disk.

imageId String

The disk image to initialize this disk from.

size Integer

The size of the disk in GB.

snapshotId String

The snapshot to initialize this disk from.

type String

Network acceleration type. By default a network is in STANDARD mode.

description string

A description of the boot disk.

imageId string

The disk image to initialize this disk from.

size number

The size of the disk in GB.

snapshotId string

The snapshot to initialize this disk from.

type string

Network acceleration type. By default a network is in STANDARD mode.

description str

A description of the boot disk.

image_id str

The disk image to initialize this disk from.

size int

The size of the disk in GB.

snapshot_id str

The snapshot to initialize this disk from.

type str

Network acceleration type. By default a network is in STANDARD mode.

description String

A description of the boot disk.

imageId String

The disk image to initialize this disk from.

size Number

The size of the disk in GB.

snapshotId String

The snapshot to initialize this disk from.

type String

Network acceleration type. By default a network is in STANDARD mode.

GetComputeInstanceGroupLoadBalancer

MaxOpeningTrafficDuration int

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

StatusMessage string

The status message of the target group.

TargetGroupDescription string

A description of the target group.

TargetGroupId string

The ID of the target group.

TargetGroupLabels Dictionary<string, string>

A set of key/value label pairs.

TargetGroupName string

The name of the target group.

MaxOpeningTrafficDuration int

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

StatusMessage string

The status message of the target group.

TargetGroupDescription string

A description of the target group.

TargetGroupId string

The ID of the target group.

TargetGroupLabels map[string]string

A set of key/value label pairs.

TargetGroupName string

The name of the target group.

maxOpeningTrafficDuration Integer

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

statusMessage String

The status message of the target group.

targetGroupDescription String

A description of the target group.

targetGroupId String

The ID of the target group.

targetGroupLabels Map<String,String>

A set of key/value label pairs.

targetGroupName String

The name of the target group.

maxOpeningTrafficDuration number

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

statusMessage string

The status message of the target group.

targetGroupDescription string

A description of the target group.

targetGroupId string

The ID of the target group.

targetGroupLabels {[key: string]: string}

A set of key/value label pairs.

targetGroupName string

The name of the target group.

max_opening_traffic_duration int

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

status_message str

The status message of the target group.

target_group_description str

A description of the target group.

target_group_id str

The ID of the target group.

target_group_labels Mapping[str, str]

A set of key/value label pairs.

target_group_name str

The name of the target group.

maxOpeningTrafficDuration Number

Timeout for waiting for the VM to be checked by the load balancer. If the timeout is exceeded, the VM will be turned off based on the deployment policy. Specified in seconds.

statusMessage String

The status message of the target group.

targetGroupDescription String

A description of the target group.

targetGroupId String

The ID of the target group.

targetGroupLabels Map<String>

A set of key/value label pairs.

targetGroupName String

The name of the target group.

GetComputeInstanceGroupLoadBalancerState

StatusMessage string

The status message of the target group.

TargetGroupId string

The ID of the target group.

StatusMessage string

The status message of the target group.

TargetGroupId string

The ID of the target group.

statusMessage String

The status message of the target group.

targetGroupId String

The ID of the target group.

statusMessage string

The status message of the target group.

targetGroupId string

The ID of the target group.

status_message str

The status message of the target group.

target_group_id str

The ID of the target group.

statusMessage String

The status message of the target group.

targetGroupId String

The ID of the target group.

GetComputeInstanceGroupScalePolicy

AutoScales List<GetComputeInstanceGroupScalePolicyAutoScale>

The auto scaling policy of the instance group. The structure is documented below.

FixedScales List<GetComputeInstanceGroupScalePolicyFixedScale>

The fixed scaling policy of the instance group. The structure is documented below.

TestAutoScales List<GetComputeInstanceGroupScalePolicyTestAutoScale>

The test auto scaling policy of the instance group. Use it to test how the auto scale works. The structure is documented below.

AutoScales []GetComputeInstanceGroupScalePolicyAutoScale

The auto scaling policy of the instance group. The structure is documented below.

FixedScales []GetComputeInstanceGroupScalePolicyFixedScale

The fixed scaling policy of the instance group. The structure is documented below.

TestAutoScales []GetComputeInstanceGroupScalePolicyTestAutoScale

The test auto scaling policy of the instance group. Use it to test how the auto scale works. The structure is documented below.

autoScales List<GetComputeInstanceGroupScalePolicyAutoScale>

The auto scaling policy of the instance group. The structure is documented below.

fixedScales List<GetComputeInstanceGroupScalePolicyFixedScale>

The fixed scaling policy of the instance group. The structure is documented below.

testAutoScales List<GetComputeInstanceGroupScalePolicyTestAutoScale>

The test auto scaling policy of the instance group. Use it to test how the auto scale works. The structure is documented below.

autoScales GetComputeInstanceGroupScalePolicyAutoScale[]

The auto scaling policy of the instance group. The structure is documented below.

fixedScales GetComputeInstanceGroupScalePolicyFixedScale[]

The fixed scaling policy of the instance group. The structure is documented below.

testAutoScales GetComputeInstanceGroupScalePolicyTestAutoScale[]

The test auto scaling policy of the instance group. Use it to test how the auto scale works. The structure is documented below.

auto_scales Sequence[GetComputeInstanceGroupScalePolicyAutoScale]

The auto scaling policy of the instance group. The structure is documented below.

fixed_scales Sequence[GetComputeInstanceGroupScalePolicyFixedScale]

The fixed scaling policy of the instance group. The structure is documented below.

test_auto_scales Sequence[GetComputeInstanceGroupScalePolicyTestAutoScale]

The test auto scaling policy of the instance group. Use it to test how the auto scale works. The structure is documented below.

autoScales List<Property Map>

The auto scaling policy of the instance group. The structure is documented below.

fixedScales List<Property Map>

The fixed scaling policy of the instance group. The structure is documented below.

testAutoScales List<Property Map>

The test auto scaling policy of the instance group. Use it to test how the auto scale works. The structure is documented below.

GetComputeInstanceGroupScalePolicyAutoScale

CpuUtilizationTarget double

Target CPU load level.

CustomRules List<GetComputeInstanceGroupScalePolicyAutoScaleCustomRule>

A list of custom rules. The structure is documented below.

InitialSize int

The initial number of instances in the instance group.

MaxSize int

The maximum number of virtual machines in the group.

MeasurementDuration int

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

MinZoneSize int

The minimum number of virtual machines in a single availability zone.

StabilizationDuration int

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

WarmupDuration int

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

CpuUtilizationTarget float64

Target CPU load level.

CustomRules []GetComputeInstanceGroupScalePolicyAutoScaleCustomRule

A list of custom rules. The structure is documented below.

InitialSize int

The initial number of instances in the instance group.

MaxSize int

The maximum number of virtual machines in the group.

MeasurementDuration int

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

MinZoneSize int

The minimum number of virtual machines in a single availability zone.

StabilizationDuration int

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

WarmupDuration int

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpuUtilizationTarget Double

Target CPU load level.

customRules List<GetComputeInstanceGroupScalePolicyAutoScaleCustomRule>

A list of custom rules. The structure is documented below.

initialSize Integer

The initial number of instances in the instance group.

maxSize Integer

The maximum number of virtual machines in the group.

measurementDuration Integer

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

minZoneSize Integer

The minimum number of virtual machines in a single availability zone.

stabilizationDuration Integer

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmupDuration Integer

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpuUtilizationTarget number

Target CPU load level.

customRules GetComputeInstanceGroupScalePolicyAutoScaleCustomRule[]

A list of custom rules. The structure is documented below.

initialSize number

The initial number of instances in the instance group.

maxSize number

The maximum number of virtual machines in the group.

measurementDuration number

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

minZoneSize number

The minimum number of virtual machines in a single availability zone.

stabilizationDuration number

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmupDuration number

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpu_utilization_target float

Target CPU load level.

custom_rules Sequence[GetComputeInstanceGroupScalePolicyAutoScaleCustomRule]

A list of custom rules. The structure is documented below.

initial_size int

The initial number of instances in the instance group.

max_size int

The maximum number of virtual machines in the group.

measurement_duration int

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

min_zone_size int

The minimum number of virtual machines in a single availability zone.

stabilization_duration int

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmup_duration int

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpuUtilizationTarget Number

Target CPU load level.

customRules List<Property Map>

A list of custom rules. The structure is documented below.

initialSize Number

The initial number of instances in the instance group.

maxSize Number

The maximum number of virtual machines in the group.

measurementDuration Number

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

minZoneSize Number

The minimum number of virtual machines in a single availability zone.

stabilizationDuration Number

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmupDuration Number

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

GetComputeInstanceGroupScalePolicyAutoScaleCustomRule

FolderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

Labels Dictionary<string, string>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
MetricName string

The name of metric.

MetricType string

Metric type, GAUGE or COUNTER.

RuleType string

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

Service string

Service of custom metric in Yandex Monitoring that should be used for scaling.

Target double

Target metric value level.

FolderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

Labels map[string]string

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
MetricName string

The name of metric.

MetricType string

Metric type, GAUGE or COUNTER.

RuleType string

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

Service string

Service of custom metric in Yandex Monitoring that should be used for scaling.

Target float64

Target metric value level.

folderId String

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels Map<String,String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metricName String

The name of metric.

metricType String

Metric type, GAUGE or COUNTER.

ruleType String

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service String

Service of custom metric in Yandex Monitoring that should be used for scaling.

target Double

Target metric value level.

folderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels {[key: string]: string}

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metricName string

The name of metric.

metricType string

Metric type, GAUGE or COUNTER.

ruleType string

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service string

Service of custom metric in Yandex Monitoring that should be used for scaling.

target number

Target metric value level.

folder_id str

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels Mapping[str, str]

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metric_name str

The name of metric.

metric_type str

Metric type, GAUGE or COUNTER.

rule_type str

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service str

Service of custom metric in Yandex Monitoring that should be used for scaling.

target float

Target metric value level.

folderId String

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels Map<String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metricName String

The name of metric.

metricType String

Metric type, GAUGE or COUNTER.

ruleType String

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service String

Service of custom metric in Yandex Monitoring that should be used for scaling.

target Number

Target metric value level.

GetComputeInstanceGroupScalePolicyFixedScale

Size int

The size of the disk in GB.

Size int

The size of the disk in GB.

size Integer

The size of the disk in GB.

size number

The size of the disk in GB.

size int

The size of the disk in GB.

size Number

The size of the disk in GB.

GetComputeInstanceGroupScalePolicyTestAutoScale

CpuUtilizationTarget double

Target CPU load level.

CustomRules List<GetComputeInstanceGroupScalePolicyTestAutoScaleCustomRule>

A list of custom rules. The structure is documented below.

InitialSize int

The initial number of instances in the instance group.

MaxSize int

The maximum number of virtual machines in the group.

MeasurementDuration int

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

MinZoneSize int

The minimum number of virtual machines in a single availability zone.

StabilizationDuration int

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

WarmupDuration int

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

CpuUtilizationTarget float64

Target CPU load level.

CustomRules []GetComputeInstanceGroupScalePolicyTestAutoScaleCustomRule

A list of custom rules. The structure is documented below.

InitialSize int

The initial number of instances in the instance group.

MaxSize int

The maximum number of virtual machines in the group.

MeasurementDuration int

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

MinZoneSize int

The minimum number of virtual machines in a single availability zone.

StabilizationDuration int

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

WarmupDuration int

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpuUtilizationTarget Double

Target CPU load level.

customRules List<GetComputeInstanceGroupScalePolicyTestAutoScaleCustomRule>

A list of custom rules. The structure is documented below.

initialSize Integer

The initial number of instances in the instance group.

maxSize Integer

The maximum number of virtual machines in the group.

measurementDuration Integer

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

minZoneSize Integer

The minimum number of virtual machines in a single availability zone.

stabilizationDuration Integer

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmupDuration Integer

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpuUtilizationTarget number

Target CPU load level.

customRules GetComputeInstanceGroupScalePolicyTestAutoScaleCustomRule[]

A list of custom rules. The structure is documented below.

initialSize number

The initial number of instances in the instance group.

maxSize number

The maximum number of virtual machines in the group.

measurementDuration number

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

minZoneSize number

The minimum number of virtual machines in a single availability zone.

stabilizationDuration number

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmupDuration number

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpu_utilization_target float

Target CPU load level.

custom_rules Sequence[GetComputeInstanceGroupScalePolicyTestAutoScaleCustomRule]

A list of custom rules. The structure is documented below.

initial_size int

The initial number of instances in the instance group.

max_size int

The maximum number of virtual machines in the group.

measurement_duration int

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

min_zone_size int

The minimum number of virtual machines in a single availability zone.

stabilization_duration int

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmup_duration int

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

cpuUtilizationTarget Number

Target CPU load level.

customRules List<Property Map>

A list of custom rules. The structure is documented below.

initialSize Number

The initial number of instances in the instance group.

maxSize Number

The maximum number of virtual machines in the group.

measurementDuration Number

The amount of time, in seconds, that metrics are averaged for. If the average value at the end of the interval is higher than the cpu_utilization_target, the instance group will increase the number of virtual machines in the group.

minZoneSize Number

The minimum number of virtual machines in a single availability zone.

stabilizationDuration Number

The minimum time interval, in seconds, to monitor the load before an instance group can reduce the number of virtual machines in the group. During this time, the group will not decrease even if the average load falls below the value of cpu_utilization_target.

warmupDuration Number

The warm-up time of the virtual machine, in seconds. During this time, traffic is fed to the virtual machine, but load metrics are not taken into account.

GetComputeInstanceGroupScalePolicyTestAutoScaleCustomRule

FolderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

Labels Dictionary<string, string>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
MetricName string

The name of metric.

MetricType string

Metric type, GAUGE or COUNTER.

RuleType string

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

Service string

Service of custom metric in Yandex Monitoring that should be used for scaling.

Target double

Target metric value level.

FolderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

Labels map[string]string

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
MetricName string

The name of metric.

MetricType string

Metric type, GAUGE or COUNTER.

RuleType string

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

Service string

Service of custom metric in Yandex Monitoring that should be used for scaling.

Target float64

Target metric value level.

folderId String

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels Map<String,String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metricName String

The name of metric.

metricType String

Metric type, GAUGE or COUNTER.

ruleType String

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service String

Service of custom metric in Yandex Monitoring that should be used for scaling.

target Double

Target metric value level.

folderId string

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels {[key: string]: string}

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metricName string

The name of metric.

metricType string

Metric type, GAUGE or COUNTER.

ruleType string

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service string

Service of custom metric in Yandex Monitoring that should be used for scaling.

target number

Target metric value level.

folder_id str

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels Mapping[str, str]

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metric_name str

The name of metric.

metric_type str

Metric type, GAUGE or COUNTER.

rule_type str

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service str

Service of custom metric in Yandex Monitoring that should be used for scaling.

target float

Target metric value level.

folderId String

Folder ID of custom metric in Yandex Monitoring that should be used for scaling.

labels Map<String>

A map of labels applied to this instance.

  • resources.0.memory - The memory size allocated to the instance.
  • resources.0.cores - Number of CPU cores allocated to the instance.
  • resources.0.core_fraction - Baseline core performance as a percent.
  • resources.0.gpus - Number of GPU cores allocated to the instance.
metricName String

The name of metric.

metricType String

Metric type, GAUGE or COUNTER.

ruleType String

Rule type: UTILIZATION - This type means that the metric applies to one instance. First, Instance Groups calculates the average metric value for each instance, then averages the values for instances in one availability zone. This type of metric must have the instance_id label. WORKLOAD - This type means that the metric applies to instances in one availability zone. This type of metric must have the zone_id label.

service String

Service of custom metric in Yandex Monitoring that should be used for scaling.

target Number

Target metric value level.

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes

This Pulumi package is based on the yandex Terraform Provider.