Google Native

Pulumi Official
Package maintained by Pulumi
v0.22.0 published on Friday, Jul 29, 2022 by Pulumi

getNodeGroup

Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the “nodes” field should not be used. Use nodeGroups.listNodes instead.

Using getNodeGroup

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 getNodeGroup(args: GetNodeGroupArgs, opts?: InvokeOptions): Promise<GetNodeGroupResult>
function getNodeGroupOutput(args: GetNodeGroupOutputArgs, opts?: InvokeOptions): Output<GetNodeGroupResult>
def get_node_group(node_group: Optional[str] = None,
                   project: Optional[str] = None,
                   zone: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetNodeGroupResult
def get_node_group_output(node_group: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   zone: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetNodeGroupResult]
func LookupNodeGroup(ctx *Context, args *LookupNodeGroupArgs, opts ...InvokeOption) (*LookupNodeGroupResult, error)
func LookupNodeGroupOutput(ctx *Context, args *LookupNodeGroupOutputArgs, opts ...InvokeOption) LookupNodeGroupResultOutput

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

public static class GetNodeGroup 
{
    public static Task<GetNodeGroupResult> InvokeAsync(GetNodeGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetNodeGroupResult> Invoke(GetNodeGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNodeGroupResult> getNodeGroup(GetNodeGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:compute/v1:getNodeGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

NodeGroup string
Zone string
Project string
NodeGroup string
Zone string
Project string
nodeGroup String
zone String
project String
nodeGroup string
zone string
project string
nodeGroup String
zone String
project String

getNodeGroup Result

The following output properties are available:

AutoscalingPolicy Pulumi.GoogleNative.Compute.V1.Outputs.NodeGroupAutoscalingPolicyResponse

Specifies how autoscaling should behave.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Description string

An optional description of this resource. Provide this property when you create the resource.

Fingerprint string
Kind string

The type of the resource. Always compute#nodeGroup for node group.

LocationHint string

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

MaintenancePolicy string

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

MaintenanceWindow Pulumi.GoogleNative.Compute.V1.Outputs.NodeGroupMaintenanceWindowResponse
Name string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

NodeTemplate string

URL of the node template to create the node group from.

SelfLink string

Server-defined URL for the resource.

Size int

The total number of nodes in the node group.

Status string
Zone string

The name of the zone where the node group resides, such as us-central1-a.

AutoscalingPolicy NodeGroupAutoscalingPolicyResponse

Specifies how autoscaling should behave.

CreationTimestamp string

Creation timestamp in RFC3339 text format.

Description string

An optional description of this resource. Provide this property when you create the resource.

Fingerprint string
Kind string

The type of the resource. Always compute#nodeGroup for node group.

LocationHint string

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

MaintenancePolicy string

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

MaintenanceWindow NodeGroupMaintenanceWindowResponse
Name string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

NodeTemplate string

URL of the node template to create the node group from.

SelfLink string

Server-defined URL for the resource.

Size int

The total number of nodes in the node group.

Status string
Zone string

The name of the zone where the node group resides, such as us-central1-a.

autoscalingPolicy NodeGroupAutoscalingPolicyResponse

Specifies how autoscaling should behave.

creationTimestamp String

Creation timestamp in RFC3339 text format.

description String

An optional description of this resource. Provide this property when you create the resource.

fingerprint String
kind String

The type of the resource. Always compute#nodeGroup for node group.

locationHint String

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

maintenancePolicy String

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

maintenanceWindow NodeGroupMaintenanceWindowResponse
name String

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

nodeTemplate String

URL of the node template to create the node group from.

selfLink String

Server-defined URL for the resource.

size Integer

The total number of nodes in the node group.

status String
zone String

The name of the zone where the node group resides, such as us-central1-a.

autoscalingPolicy NodeGroupAutoscalingPolicyResponse

Specifies how autoscaling should behave.

creationTimestamp string

Creation timestamp in RFC3339 text format.

description string

An optional description of this resource. Provide this property when you create the resource.

fingerprint string
kind string

The type of the resource. Always compute#nodeGroup for node group.

locationHint string

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

maintenancePolicy string

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

maintenanceWindow NodeGroupMaintenanceWindowResponse
name string

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

nodeTemplate string

URL of the node template to create the node group from.

selfLink string

Server-defined URL for the resource.

size number

The total number of nodes in the node group.

status string
zone string

The name of the zone where the node group resides, such as us-central1-a.

autoscaling_policy NodeGroupAutoscalingPolicyResponse

Specifies how autoscaling should behave.

creation_timestamp str

Creation timestamp in RFC3339 text format.

description str

An optional description of this resource. Provide this property when you create the resource.

fingerprint str
kind str

The type of the resource. Always compute#nodeGroup for node group.

location_hint str

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

maintenance_policy str

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

maintenance_window NodeGroupMaintenanceWindowResponse
name str

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

node_template str

URL of the node template to create the node group from.

self_link str

Server-defined URL for the resource.

size int

The total number of nodes in the node group.

status str
zone str

The name of the zone where the node group resides, such as us-central1-a.

autoscalingPolicy Property Map

Specifies how autoscaling should behave.

creationTimestamp String

Creation timestamp in RFC3339 text format.

description String

An optional description of this resource. Provide this property when you create the resource.

fingerprint String
kind String

The type of the resource. Always compute#nodeGroup for node group.

locationHint String

An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.

maintenancePolicy String

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.

maintenanceWindow Property Map
name String

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

nodeTemplate String

URL of the node template to create the node group from.

selfLink String

Server-defined URL for the resource.

size Number

The total number of nodes in the node group.

status String
zone String

The name of the zone where the node group resides, such as us-central1-a.

Supporting Types

DurationResponse

Nanos int

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Nanos int

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

Seconds string

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos Integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds String

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos number

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds string

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos int

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds str

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

nanos Number

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

seconds String

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

NodeGroupAutoscalingPolicyResponse

MaxNodes int

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

MinNodes int

The minimum number of nodes that the group should have.

Mode string

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

MaxNodes int

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

MinNodes int

The minimum number of nodes that the group should have.

Mode string

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

maxNodes Integer

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

minNodes Integer

The minimum number of nodes that the group should have.

mode String

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

maxNodes number

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

minNodes number

The minimum number of nodes that the group should have.

mode string

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

max_nodes int

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

min_nodes int

The minimum number of nodes that the group should have.

mode str

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

maxNodes Number

The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.

minNodes Number

The minimum number of nodes that the group should have.

mode String

The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.

NodeGroupMaintenanceWindowResponse

MaintenanceDuration Pulumi.GoogleNative.Compute.V1.Inputs.DurationResponse

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

StartTime string

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

MaintenanceDuration DurationResponse

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

StartTime string

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

maintenanceDuration DurationResponse

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

startTime String

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

maintenanceDuration DurationResponse

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

startTime string

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

maintenance_duration DurationResponse

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

start_time str

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

maintenanceDuration Property Map

[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.

startTime String

Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0