getRegionInstanceGroupManager.go

// Code generated by the Pulumi SDK Generator DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package alpha

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-google-native/sdk/go/google/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Returns all of the details about the specified managed instance group.
func LookupRegionInstanceGroupManager(ctx *pulumi.Context, args *LookupRegionInstanceGroupManagerArgs, opts ...pulumi.InvokeOption) (*LookupRegionInstanceGroupManagerResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv LookupRegionInstanceGroupManagerResult
	err := ctx.Invoke("google-native:compute/alpha:getRegionInstanceGroupManager", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

type LookupRegionInstanceGroupManagerArgs struct {
	InstanceGroupManager string  `pulumi:"instanceGroupManager"`
	Project              *string `pulumi:"project"`
	Region               string  `pulumi:"region"`
}

type LookupRegionInstanceGroupManagerResult struct {
	// Specifies configuration that overrides the instance template configuration for the group.
	AllInstancesConfig InstanceGroupManagerAllInstancesConfigResponse `pulumi:"allInstancesConfig"`
	// The autohealing policy for this managed instance group. You can specify only one value.
	AutoHealingPolicies []InstanceGroupManagerAutoHealingPolicyResponse `pulumi:"autoHealingPolicies"`
	// The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
	BaseInstanceName string `pulumi:"baseInstanceName"`
	// The creation timestamp for this managed instance group in RFC3339 text format.
	CreationTimestamp string `pulumi:"creationTimestamp"`
	// The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
	CurrentActions InstanceGroupManagerActionsSummaryResponse `pulumi:"currentActions"`
	// An optional description of this resource.
	Description string `pulumi:"description"`
	// Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
	DistributionPolicy DistributionPolicyResponse `pulumi:"distributionPolicy"`
	// The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
	FailoverAction string `pulumi:"failoverAction"`
	// Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
	Fingerprint string `pulumi:"fingerprint"`
	// Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
	InstanceFlexibilityPolicy InstanceGroupManagerInstanceFlexibilityPolicyResponse `pulumi:"instanceFlexibilityPolicy"`
	// The URL of the Instance Group resource.
	InstanceGroup string `pulumi:"instanceGroup"`
	// The repair policy for this managed instance group.
	InstanceLifecyclePolicy InstanceGroupManagerInstanceLifecyclePolicyResponse `pulumi:"instanceLifecyclePolicy"`
	// The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
	InstanceTemplate string `pulumi:"instanceTemplate"`
	// The resource type, which is always compute#instanceGroupManager for managed instance groups.
	Kind string `pulumi:"kind"`
	// Pagination behavior of the listManagedInstances API method for this managed instance group.
	ListManagedInstancesResults string `pulumi:"listManagedInstancesResults"`
	// The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
	Name string `pulumi:"name"`
	// Named ports configured for the Instance Groups complementary to this Instance Group Manager.
	NamedPorts []NamedPortResponse `pulumi:"namedPorts"`
	// The URL of the region where the managed instance group resides (for regional resources).
	Region string `pulumi:"region"`
	// The URL for this managed instance group. The server defines this URL.
	SelfLink string `pulumi:"selfLink"`
	// Server-defined URL for this resource with the resource id.
	SelfLinkWithId string `pulumi:"selfLinkWithId"`
	// The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
	ServiceAccount string `pulumi:"serviceAccount"`
	// Standby policy for stopped and suspended instances.
	StandbyPolicy InstanceGroupManagerStandbyPolicyResponse `pulumi:"standbyPolicy"`
	// Stateful configuration for this Instanced Group Manager
	StatefulPolicy StatefulPolicyResponse `pulumi:"statefulPolicy"`
	// The status of this managed instance group.
	Status InstanceGroupManagerStatusResponse `pulumi:"status"`
	// The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
	TargetPools []string `pulumi:"targetPools"`
	// The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
	TargetSize int `pulumi:"targetSize"`
	// The unit of measure for the target size.
	TargetSizeUnit string `pulumi:"targetSizeUnit"`
	// The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.
	TargetStoppedSize int `pulumi:"targetStoppedSize"`
	// The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.
	TargetSuspendedSize int `pulumi:"targetSuspendedSize"`
	// The update policy for this managed instance group.
	UpdatePolicy InstanceGroupManagerUpdatePolicyResponse `pulumi:"updatePolicy"`
	// Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
	Versions []InstanceGroupManagerVersionResponse `pulumi:"versions"`
	// The URL of a zone where the managed instance group is located (for zonal resources).
	Zone string `pulumi:"zone"`
}

func LookupRegionInstanceGroupManagerOutput(ctx *pulumi.Context, args LookupRegionInstanceGroupManagerOutputArgs, opts ...pulumi.InvokeOption) LookupRegionInstanceGroupManagerResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (LookupRegionInstanceGroupManagerResult, error) {
			args := v.(LookupRegionInstanceGroupManagerArgs)
			r, err := LookupRegionInstanceGroupManager(ctx, &args, opts...)
			var s LookupRegionInstanceGroupManagerResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(LookupRegionInstanceGroupManagerResultOutput)
}

type LookupRegionInstanceGroupManagerOutputArgs struct {
	InstanceGroupManager pulumi.StringInput    `pulumi:"instanceGroupManager"`
	Project              pulumi.StringPtrInput `pulumi:"project"`
	Region               pulumi.StringInput    `pulumi:"region"`
}

func (LookupRegionInstanceGroupManagerOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupRegionInstanceGroupManagerArgs)(nil)).Elem()
}

type LookupRegionInstanceGroupManagerResultOutput struct{ *pulumi.OutputState }

func (LookupRegionInstanceGroupManagerResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupRegionInstanceGroupManagerResult)(nil)).Elem()
}

func (o LookupRegionInstanceGroupManagerResultOutput) ToLookupRegionInstanceGroupManagerResultOutput() LookupRegionInstanceGroupManagerResultOutput {
	return o
}

func (o LookupRegionInstanceGroupManagerResultOutput) ToLookupRegionInstanceGroupManagerResultOutputWithContext(ctx context.Context) LookupRegionInstanceGroupManagerResultOutput {
	return o
}

// Specifies configuration that overrides the instance template configuration for the group.
func (o LookupRegionInstanceGroupManagerResultOutput) AllInstancesConfig() InstanceGroupManagerAllInstancesConfigResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) InstanceGroupManagerAllInstancesConfigResponse {
		return v.AllInstancesConfig
	}).(InstanceGroupManagerAllInstancesConfigResponseOutput)
}

// The autohealing policy for this managed instance group. You can specify only one value.
func (o LookupRegionInstanceGroupManagerResultOutput) AutoHealingPolicies() InstanceGroupManagerAutoHealingPolicyResponseArrayOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) []InstanceGroupManagerAutoHealingPolicyResponse {
		return v.AutoHealingPolicies
	}).(InstanceGroupManagerAutoHealingPolicyResponseArrayOutput)
}

// The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
func (o LookupRegionInstanceGroupManagerResultOutput) BaseInstanceName() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.BaseInstanceName }).(pulumi.StringOutput)
}

// The creation timestamp for this managed instance group in RFC3339 text format.
func (o LookupRegionInstanceGroupManagerResultOutput) CreationTimestamp() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.CreationTimestamp }).(pulumi.StringOutput)
}

// The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
func (o LookupRegionInstanceGroupManagerResultOutput) CurrentActions() InstanceGroupManagerActionsSummaryResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) InstanceGroupManagerActionsSummaryResponse {
		return v.CurrentActions
	}).(InstanceGroupManagerActionsSummaryResponseOutput)
}

// An optional description of this resource.
func (o LookupRegionInstanceGroupManagerResultOutput) Description() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.Description }).(pulumi.StringOutput)
}

// Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
func (o LookupRegionInstanceGroupManagerResultOutput) DistributionPolicy() DistributionPolicyResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) DistributionPolicyResponse { return v.DistributionPolicy }).(DistributionPolicyResponseOutput)
}

// The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
func (o LookupRegionInstanceGroupManagerResultOutput) FailoverAction() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.FailoverAction }).(pulumi.StringOutput)
}

// Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
func (o LookupRegionInstanceGroupManagerResultOutput) Fingerprint() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.Fingerprint }).(pulumi.StringOutput)
}

// Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
func (o LookupRegionInstanceGroupManagerResultOutput) InstanceFlexibilityPolicy() InstanceGroupManagerInstanceFlexibilityPolicyResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) InstanceGroupManagerInstanceFlexibilityPolicyResponse {
		return v.InstanceFlexibilityPolicy
	}).(InstanceGroupManagerInstanceFlexibilityPolicyResponseOutput)
}

// The URL of the Instance Group resource.
func (o LookupRegionInstanceGroupManagerResultOutput) InstanceGroup() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.InstanceGroup }).(pulumi.StringOutput)
}

// The repair policy for this managed instance group.
func (o LookupRegionInstanceGroupManagerResultOutput) InstanceLifecyclePolicy() InstanceGroupManagerInstanceLifecyclePolicyResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) InstanceGroupManagerInstanceLifecyclePolicyResponse {
		return v.InstanceLifecyclePolicy
	}).(InstanceGroupManagerInstanceLifecyclePolicyResponseOutput)
}

// The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
func (o LookupRegionInstanceGroupManagerResultOutput) InstanceTemplate() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.InstanceTemplate }).(pulumi.StringOutput)
}

// The resource type, which is always compute#instanceGroupManager for managed instance groups.
func (o LookupRegionInstanceGroupManagerResultOutput) Kind() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.Kind }).(pulumi.StringOutput)
}

// Pagination behavior of the listManagedInstances API method for this managed instance group.
func (o LookupRegionInstanceGroupManagerResultOutput) ListManagedInstancesResults() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.ListManagedInstancesResults }).(pulumi.StringOutput)
}

// The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
func (o LookupRegionInstanceGroupManagerResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.Name }).(pulumi.StringOutput)
}

// Named ports configured for the Instance Groups complementary to this Instance Group Manager.
func (o LookupRegionInstanceGroupManagerResultOutput) NamedPorts() NamedPortResponseArrayOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) []NamedPortResponse { return v.NamedPorts }).(NamedPortResponseArrayOutput)
}

// The URL of the region where the managed instance group resides (for regional resources).
func (o LookupRegionInstanceGroupManagerResultOutput) Region() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.Region }).(pulumi.StringOutput)
}

// The URL for this managed instance group. The server defines this URL.
func (o LookupRegionInstanceGroupManagerResultOutput) SelfLink() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.SelfLink }).(pulumi.StringOutput)
}

// Server-defined URL for this resource with the resource id.
func (o LookupRegionInstanceGroupManagerResultOutput) SelfLinkWithId() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.SelfLinkWithId }).(pulumi.StringOutput)
}

// The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
func (o LookupRegionInstanceGroupManagerResultOutput) ServiceAccount() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.ServiceAccount }).(pulumi.StringOutput)
}

// Standby policy for stopped and suspended instances.
func (o LookupRegionInstanceGroupManagerResultOutput) StandbyPolicy() InstanceGroupManagerStandbyPolicyResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) InstanceGroupManagerStandbyPolicyResponse {
		return v.StandbyPolicy
	}).(InstanceGroupManagerStandbyPolicyResponseOutput)
}

// Stateful configuration for this Instanced Group Manager
func (o LookupRegionInstanceGroupManagerResultOutput) StatefulPolicy() StatefulPolicyResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) StatefulPolicyResponse { return v.StatefulPolicy }).(StatefulPolicyResponseOutput)
}

// The status of this managed instance group.
func (o LookupRegionInstanceGroupManagerResultOutput) Status() InstanceGroupManagerStatusResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) InstanceGroupManagerStatusResponse { return v.Status }).(InstanceGroupManagerStatusResponseOutput)
}

// The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
func (o LookupRegionInstanceGroupManagerResultOutput) TargetPools() pulumi.StringArrayOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) []string { return v.TargetPools }).(pulumi.StringArrayOutput)
}

// The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
func (o LookupRegionInstanceGroupManagerResultOutput) TargetSize() pulumi.IntOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) int { return v.TargetSize }).(pulumi.IntOutput)
}

// The unit of measure for the target size.
func (o LookupRegionInstanceGroupManagerResultOutput) TargetSizeUnit() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.TargetSizeUnit }).(pulumi.StringOutput)
}

// The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.
func (o LookupRegionInstanceGroupManagerResultOutput) TargetStoppedSize() pulumi.IntOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) int { return v.TargetStoppedSize }).(pulumi.IntOutput)
}

// The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.
func (o LookupRegionInstanceGroupManagerResultOutput) TargetSuspendedSize() pulumi.IntOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) int { return v.TargetSuspendedSize }).(pulumi.IntOutput)
}

// The update policy for this managed instance group.
func (o LookupRegionInstanceGroupManagerResultOutput) UpdatePolicy() InstanceGroupManagerUpdatePolicyResponseOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) InstanceGroupManagerUpdatePolicyResponse {
		return v.UpdatePolicy
	}).(InstanceGroupManagerUpdatePolicyResponseOutput)
}

// Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
func (o LookupRegionInstanceGroupManagerResultOutput) Versions() InstanceGroupManagerVersionResponseArrayOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) []InstanceGroupManagerVersionResponse {
		return v.Versions
	}).(InstanceGroupManagerVersionResponseArrayOutput)
}

// The URL of a zone where the managed instance group is located (for zonal resources).
func (o LookupRegionInstanceGroupManagerResultOutput) Zone() pulumi.StringOutput {
	return o.ApplyT(func(v LookupRegionInstanceGroupManagerResult) string { return v.Zone }).(pulumi.StringOutput)
}

func init() {
	pulumi.RegisterOutputType(LookupRegionInstanceGroupManagerResultOutput{})
}