aws.autoscaling.getGroup
Use this data source to get information on an existing autoscaling group.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var foo = Aws.AutoScaling.GetGroup.Invoke(new()
{
Name = "foo",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/autoscaling"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := autoscaling.LookupGroup(ctx, &autoscaling.LookupGroupArgs{
Name: "foo",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.autoscaling.AutoscalingFunctions;
import com.pulumi.aws.autoscaling.inputs.GetGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var foo = AutoscalingFunctions.getGroup(GetGroupArgs.builder()
.name("foo")
.build());
}
}
import pulumi
import pulumi_aws as aws
foo = aws.autoscaling.get_group(name="foo")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = aws.autoscaling.getGroup({
name: "foo",
});
variables:
foo:
fn::invoke:
Function: aws:autoscaling:getGroup
Arguments:
name: foo
Using getGroup
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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
def get_group(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
> Note: This function is named LookupGroup
in the Go SDK.
public static class GetGroup
{
public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:autoscaling/getGroup:getGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
Specify the exact name of the desired autoscaling group.
- Name string
Specify the exact name of the desired autoscaling group.
- name String
Specify the exact name of the desired autoscaling group.
- name string
Specify the exact name of the desired autoscaling group.
- name str
Specify the exact name of the desired autoscaling group.
- name String
Specify the exact name of the desired autoscaling group.
getGroup Result
The following output properties are available:
- Arn string
ARN of the Auto Scaling group.
- Availability
Zones List<string> One or more Availability Zones for the group.
- Default
Cooldown int - Desired
Capacity int Desired size of the group.
- Desired
Capacity stringType The unit of measurement for the value returned for
desired_capacity
.- Enabled
Metrics List<string> List of metrics enabled for collection.
- Health
Check intGrace Period The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
- Health
Check stringType Service to use for the health checks. The valid values are EC2 and ELB.
- Id string
The provider-assigned unique ID for this managed resource.
- Launch
Configuration string The name of the associated launch configuration.
- Launch
Templates List<GetGroup Launch Template> - Load
Balancers List<string> One or more load balancers associated with the group.
- Max
Size int Maximum size of the group.
- Min
Size int Minimum size of the group.
- Name string
Name of the Auto Scaling Group.
- New
Instances boolProtected From Scale In - Placement
Group string Name of the placement group into which to launch your instances, if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the Amazon Elastic Compute Cloud User Guide.
- Service
Linked stringRole Arn ARN of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
- Status string
Current state of the group when DeleteAutoScalingGroup is in progress.
- Target
Group List<string>Arns ARNs of the target groups for your load balancer.
- Termination
Policies List<string> The termination policies for the group.
- Vpc
Zone stringIdentifier VPC ID for the group.
- Arn string
ARN of the Auto Scaling group.
- Availability
Zones []string One or more Availability Zones for the group.
- Default
Cooldown int - Desired
Capacity int Desired size of the group.
- Desired
Capacity stringType The unit of measurement for the value returned for
desired_capacity
.- Enabled
Metrics []string List of metrics enabled for collection.
- Health
Check intGrace Period The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
- Health
Check stringType Service to use for the health checks. The valid values are EC2 and ELB.
- Id string
The provider-assigned unique ID for this managed resource.
- Launch
Configuration string The name of the associated launch configuration.
- Launch
Templates []GetGroup Launch Template - Load
Balancers []string One or more load balancers associated with the group.
- Max
Size int Maximum size of the group.
- Min
Size int Minimum size of the group.
- Name string
Name of the Auto Scaling Group.
- New
Instances boolProtected From Scale In - Placement
Group string Name of the placement group into which to launch your instances, if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the Amazon Elastic Compute Cloud User Guide.
- Service
Linked stringRole Arn ARN of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
- Status string
Current state of the group when DeleteAutoScalingGroup is in progress.
- Target
Group []stringArns ARNs of the target groups for your load balancer.
- Termination
Policies []string The termination policies for the group.
- Vpc
Zone stringIdentifier VPC ID for the group.
- arn String
ARN of the Auto Scaling group.
- availability
Zones List<String> One or more Availability Zones for the group.
- default
Cooldown Integer - desired
Capacity Integer Desired size of the group.
- desired
Capacity StringType The unit of measurement for the value returned for
desired_capacity
.- enabled
Metrics List<String> List of metrics enabled for collection.
- health
Check IntegerGrace Period The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
- health
Check StringType Service to use for the health checks. The valid values are EC2 and ELB.
- id String
The provider-assigned unique ID for this managed resource.
- launch
Configuration String The name of the associated launch configuration.
- launch
Templates List<GetGroup Launch Template> - load
Balancers List<String> One or more load balancers associated with the group.
- max
Size Integer Maximum size of the group.
- min
Size Integer Minimum size of the group.
- name String
Name of the Auto Scaling Group.
- new
Instances BooleanProtected From Scale In - placement
Group String Name of the placement group into which to launch your instances, if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the Amazon Elastic Compute Cloud User Guide.
- service
Linked StringRole Arn ARN of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
- status String
Current state of the group when DeleteAutoScalingGroup is in progress.
- target
Group List<String>Arns ARNs of the target groups for your load balancer.
- termination
Policies List<String> The termination policies for the group.
- vpc
Zone StringIdentifier VPC ID for the group.
- arn string
ARN of the Auto Scaling group.
- availability
Zones string[] One or more Availability Zones for the group.
- default
Cooldown number - desired
Capacity number Desired size of the group.
- desired
Capacity stringType The unit of measurement for the value returned for
desired_capacity
.- enabled
Metrics string[] List of metrics enabled for collection.
- health
Check numberGrace Period The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
- health
Check stringType Service to use for the health checks. The valid values are EC2 and ELB.
- id string
The provider-assigned unique ID for this managed resource.
- launch
Configuration string The name of the associated launch configuration.
- launch
Templates GetGroup Launch Template[] - load
Balancers string[] One or more load balancers associated with the group.
- max
Size number Maximum size of the group.
- min
Size number Minimum size of the group.
- name string
Name of the Auto Scaling Group.
- new
Instances booleanProtected From Scale In - placement
Group string Name of the placement group into which to launch your instances, if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the Amazon Elastic Compute Cloud User Guide.
- service
Linked stringRole Arn ARN of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
- status string
Current state of the group when DeleteAutoScalingGroup is in progress.
- target
Group string[]Arns ARNs of the target groups for your load balancer.
- termination
Policies string[] The termination policies for the group.
- vpc
Zone stringIdentifier VPC ID for the group.
- arn str
ARN of the Auto Scaling group.
- availability_
zones Sequence[str] One or more Availability Zones for the group.
- default_
cooldown int - desired_
capacity int Desired size of the group.
- desired_
capacity_ strtype The unit of measurement for the value returned for
desired_capacity
.- enabled_
metrics Sequence[str] List of metrics enabled for collection.
- health_
check_ intgrace_ period The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
- health_
check_ strtype Service to use for the health checks. The valid values are EC2 and ELB.
- id str
The provider-assigned unique ID for this managed resource.
- launch_
configuration str The name of the associated launch configuration.
- launch_
templates Sequence[GetGroup Launch Template] - load_
balancers Sequence[str] One or more load balancers associated with the group.
- max_
size int Maximum size of the group.
- min_
size int Minimum size of the group.
- name str
Name of the Auto Scaling Group.
- new_
instances_ boolprotected_ from_ scale_ in - placement_
group str Name of the placement group into which to launch your instances, if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the Amazon Elastic Compute Cloud User Guide.
- service_
linked_ strrole_ arn ARN of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
- status str
Current state of the group when DeleteAutoScalingGroup is in progress.
- target_
group_ Sequence[str]arns ARNs of the target groups for your load balancer.
- termination_
policies Sequence[str] The termination policies for the group.
- vpc_
zone_ stridentifier VPC ID for the group.
- arn String
ARN of the Auto Scaling group.
- availability
Zones List<String> One or more Availability Zones for the group.
- default
Cooldown Number - desired
Capacity Number Desired size of the group.
- desired
Capacity StringType The unit of measurement for the value returned for
desired_capacity
.- enabled
Metrics List<String> List of metrics enabled for collection.
- health
Check NumberGrace Period The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
- health
Check StringType Service to use for the health checks. The valid values are EC2 and ELB.
- id String
The provider-assigned unique ID for this managed resource.
- launch
Configuration String The name of the associated launch configuration.
- launch
Templates List<Property Map> - load
Balancers List<String> One or more load balancers associated with the group.
- max
Size Number Maximum size of the group.
- min
Size Number Minimum size of the group.
- name String
Name of the Auto Scaling Group.
- new
Instances BooleanProtected From Scale In - placement
Group String Name of the placement group into which to launch your instances, if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the Amazon Elastic Compute Cloud User Guide.
- service
Linked StringRole Arn ARN of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
- status String
Current state of the group when DeleteAutoScalingGroup is in progress.
- target
Group List<String>Arns ARNs of the target groups for your load balancer.
- termination
Policies List<String> The termination policies for the group.
- vpc
Zone StringIdentifier VPC ID for the group.
Supporting Types
GetGroupLaunchTemplate
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.