Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.compute/alpha.getNodeGroup
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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/alpha:getNodeGroup
arguments:
# arguments dictionary
The following arguments are supported:
- node_
group str - zone str
- project str
getNodeGroup Result
The following output properties are available:
- Autoscaling
Policy Pulumi.Google Native. Compute. Alpha. Outputs. Node Group Autoscaling Policy Response - Specifies how autoscaling should behave.
- Creation
Timestamp 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.
- Location
Hint 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.
- Maintenance
Interval string - Specifies the frequency of planned maintenance events. The accepted values are:
AS_NEEDED
andRECURRENT
. - Maintenance
Policy 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.
- Maintenance
Window Pulumi.Google Native. Compute. Alpha. Outputs. Node Group Maintenance Window Response - 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. - Node
Template string - URL of the node template to create the node group from.
- Self
Link string - Server-defined URL for the resource.
- Self
Link stringWith Id - Server-defined URL for this resource with the resource id.
- Pulumi.
Google Native. Compute. Alpha. Outputs. Share Settings Response - Share-settings for the node group
- 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.
- Autoscaling
Policy NodeGroup Autoscaling Policy Response - Specifies how autoscaling should behave.
- Creation
Timestamp 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.
- Location
Hint 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.
- Maintenance
Interval string - Specifies the frequency of planned maintenance events. The accepted values are:
AS_NEEDED
andRECURRENT
. - Maintenance
Policy 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.
- Maintenance
Window NodeGroup Maintenance Window Response - 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. - Node
Template string - URL of the node template to create the node group from.
- Self
Link string - Server-defined URL for the resource.
- Self
Link stringWith Id - Server-defined URL for this resource with the resource id.
- Share
Settings Response - Share-settings for the node group
- 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.
- autoscaling
Policy NodeGroup Autoscaling Policy Response - Specifies how autoscaling should behave.
- creation
Timestamp 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.
- location
Hint 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.
- maintenance
Interval String - Specifies the frequency of planned maintenance events. The accepted values are:
AS_NEEDED
andRECURRENT
. - maintenance
Policy 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.
- maintenance
Window NodeGroup Maintenance Window Response - 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. - node
Template String - URL of the node template to create the node group from.
- self
Link String - Server-defined URL for the resource.
- self
Link StringWith Id - Server-defined URL for this resource with the resource id.
- Share
Settings Response - Share-settings for the node group
- 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.
- autoscaling
Policy NodeGroup Autoscaling Policy Response - Specifies how autoscaling should behave.
- creation
Timestamp 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.
- location
Hint 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.
- maintenance
Interval string - Specifies the frequency of planned maintenance events. The accepted values are:
AS_NEEDED
andRECURRENT
. - maintenance
Policy 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.
- maintenance
Window NodeGroup Maintenance Window Response - 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. - node
Template string - URL of the node template to create the node group from.
- self
Link string - Server-defined URL for the resource.
- self
Link stringWith Id - Server-defined URL for this resource with the resource id.
- Share
Settings Response - Share-settings for the node group
- 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 NodeGroup Autoscaling Policy Response - 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_
interval str - Specifies the frequency of planned maintenance events. The accepted values are:
AS_NEEDED
andRECURRENT
. - 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 NodeGroup Maintenance Window Response - 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.
- self_
link_ strwith_ id - Server-defined URL for this resource with the resource id.
- Share
Settings Response - Share-settings for the node group
- 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.
- autoscaling
Policy Property Map - Specifies how autoscaling should behave.
- creation
Timestamp 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.
- location
Hint 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.
- maintenance
Interval String - Specifies the frequency of planned maintenance events. The accepted values are:
AS_NEEDED
andRECURRENT
. - maintenance
Policy 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.
- maintenance
Window 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. - node
Template String - URL of the node template to create the node group from.
- self
Link String - Server-defined URL for the resource.
- self
Link StringWith Id - Server-defined URL for this resource with the resource id.
- Property Map
- Share-settings for the node group
- 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 positivenanos
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 positivenanos
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 positivenanos
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 positivenanos
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 positivenanos
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 positivenanos
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
- 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 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 string
- The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.
- max
Nodes Integer - The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
- min
Nodes 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.
- max
Nodes number - The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
- min
Nodes 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.
- max
Nodes Number - The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.
- min
Nodes 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
- Duration string
- [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- Maintenance
Duration Pulumi.Google Native. Compute. Alpha. Inputs. Duration Response - [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- Start
Time 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.
- Duration string
- [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- Maintenance
Duration DurationResponse - [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- Start
Time 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.
- duration String
- [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- maintenance
Duration DurationResponse - [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- start
Time 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.
- duration string
- [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- maintenance
Duration DurationResponse - [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- start
Time 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.
- duration str
- [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- 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.
- duration String
- [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- maintenance
Duration Property Map - [Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.
- start
Time 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.
ShareSettingsResponse
- Folder
Map Dictionary<string, string> - A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. Folder id should be a string of number, and without "folders/" prefix.
- Project
Map Dictionary<string, string> - A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- Projects List<string>
- A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- string
- Type of sharing for this shared-reservation
- Folder
Map map[string]string - A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. Folder id should be a string of number, and without "folders/" prefix.
- Project
Map map[string]string - A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- Projects []string
- A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- string
- Type of sharing for this shared-reservation
- folder
Map Map<String,String> - A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. Folder id should be a string of number, and without "folders/" prefix.
- project
Map Map<String,String> - A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- projects List<String>
- A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- String
- Type of sharing for this shared-reservation
- folder
Map {[key: string]: string} - A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. Folder id should be a string of number, and without "folders/" prefix.
- project
Map {[key: string]: string} - A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- projects string[]
- A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- string
- Type of sharing for this shared-reservation
- folder_
map Mapping[str, str] - A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. Folder id should be a string of number, and without "folders/" prefix.
- project_
map Mapping[str, str] - A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- projects Sequence[str]
- A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- str
- Type of sharing for this shared-reservation
- folder
Map Map<String> - A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. Folder id should be a string of number, and without "folders/" prefix.
- project
Map Map<String> - A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- projects List<String>
- A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.
- String
- Type of sharing for this shared-reservation
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.