aws-native.gameliftstreams.getStreamGroup

AWS Cloud Control v1.50.0, Jan 26 26

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.50.0 published on Monday, Jan 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.50.0 published on Monday, Jan 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getStreamGroup

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 getStreamGroup(args: GetStreamGroupArgs, opts?: InvokeOptions): Promise<GetStreamGroupResult>
function getStreamGroupOutput(args: GetStreamGroupOutputArgs, opts?: InvokeOptions): Output<GetStreamGroupResult>

def get_stream_group(arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetStreamGroupResult
def get_stream_group_output(arn: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetStreamGroupResult]

func LookupStreamGroup(ctx *Context, args *LookupStreamGroupArgs, opts ...InvokeOption) (*LookupStreamGroupResult, error)
func LookupStreamGroupOutput(ctx *Context, args *LookupStreamGroupOutputArgs, opts ...InvokeOption) LookupStreamGroupResultOutput

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

public static class GetStreamGroup 
{
    public static Task<GetStreamGroupResult> InvokeAsync(GetStreamGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamGroupResult> Invoke(GetStreamGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStreamGroupResult> getStreamGroup(GetStreamGroupArgs args, InvokeOptions options)
public static Output<GetStreamGroupResult> getStreamGroup(GetStreamGroupArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:gameliftstreams:getStreamGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .

Arn string: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .

arn String: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .

arn string: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .

arn str: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .

arn String: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .

getStreamGroup Result

The following output properties are available:

Arn string: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .
DefaultApplication Pulumi.AwsNative.GameLiftStreams.Outputs.StreamGroupDefaultApplication: Object that identifies the Amazon GameLift Streams application to stream with this stream group.
Description string: A descriptive label for the stream group.
Id string: An ID that uniquely identifies the stream group resource. For example: sg-1AB2C3De4 .
LocationConfigurations List<Pulumi.AwsNative.GameLiftStreams.Outputs.StreamGroupLocationConfiguration>: A set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is the AWS Region where you are specifying this resource.
Tags Dictionary<string, string>: A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See Tagging AWS Resources in the AWS General Reference .

Arn string: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .
DefaultApplication StreamGroupDefaultApplication: Object that identifies the Amazon GameLift Streams application to stream with this stream group.
Description string: A descriptive label for the stream group.
Id string: An ID that uniquely identifies the stream group resource. For example: sg-1AB2C3De4 .
LocationConfigurations []StreamGroupLocationConfiguration: A set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is the AWS Region where you are specifying this resource.
Tags map[string]string: A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See Tagging AWS Resources in the AWS General Reference .

arn String: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .
defaultApplication StreamGroupDefaultApplication: Object that identifies the Amazon GameLift Streams application to stream with this stream group.
description String: A descriptive label for the stream group.
id String: An ID that uniquely identifies the stream group resource. For example: sg-1AB2C3De4 .
locationConfigurations List<StreamGroupLocationConfiguration>: A set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is the AWS Region where you are specifying this resource.
tags Map<String,String>: A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See Tagging AWS Resources in the AWS General Reference .

arn string: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .
defaultApplication StreamGroupDefaultApplication: Object that identifies the Amazon GameLift Streams application to stream with this stream group.
description string: A descriptive label for the stream group.
id string: An ID that uniquely identifies the stream group resource. For example: sg-1AB2C3De4 .
locationConfigurations StreamGroupLocationConfiguration[]: A set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is the AWS Region where you are specifying this resource.
tags {[key: string]: string}: A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See Tagging AWS Resources in the AWS General Reference .

arn str: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .
default_application StreamGroupDefaultApplication: Object that identifies the Amazon GameLift Streams application to stream with this stream group.
description str: A descriptive label for the stream group.
id str: An ID that uniquely identifies the stream group resource. For example: sg-1AB2C3De4 .
location_configurations Sequence[StreamGroupLocationConfiguration]: A set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is the AWS Region where you are specifying this resource.
tags Mapping[str, str]: A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See Tagging AWS Resources in the AWS General Reference .

arn String: An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. For example: arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 .
defaultApplication Property Map: Object that identifies the Amazon GameLift Streams application to stream with this stream group.
description String: A descriptive label for the stream group.
id String: An ID that uniquely identifies the stream group resource. For example: sg-1AB2C3De4 .
locationConfigurations List<Property Map>: A set of one or more locations and the streaming capacity for each location. One of the locations MUST be your primary location, which is the AWS Region where you are specifying this resource.
tags Map<String>: A list of labels to assign to the new stream group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See Tagging AWS Resources in the AWS General Reference .

Supporting Types

StreamGroupDefaultApplication

Arn string: An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
Id string: An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

Arn string: An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
Id string: An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

arn String: An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
id String: An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

arn string: An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
id string: An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

arn str: An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
id str: An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

arn String: An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6 .
id String: An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6 .

StreamGroupLocationConfiguration

LocationName string: A location's name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .
AlwaysOnCapacity int: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
MaximumCapacity int
OnDemandCapacity int: This shape is deprecated.
TargetIdleCapacity int

LocationName string: A location's name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .
AlwaysOnCapacity int: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
MaximumCapacity int
OnDemandCapacity int: This shape is deprecated.
TargetIdleCapacity int

locationName String: A location's name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .
alwaysOnCapacity Integer: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
maximumCapacity Integer
onDemandCapacity Integer: This shape is deprecated.
targetIdleCapacity Integer

locationName string: A location's name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .
alwaysOnCapacity number: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
maximumCapacity number
onDemandCapacity number: This shape is deprecated.
targetIdleCapacity number

location_name str: A location's name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .
always_on_capacity int: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
maximum_capacity int
on_demand_capacity int: This shape is deprecated.
target_idle_capacity int

locationName String: A location's name. For example, us-east-1 . For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide .
alwaysOnCapacity Number: This setting, if non-zero, indicates minimum streaming capacity which is allocated to you and is never released back to the service. You pay for this base level of capacity at all times, whether used or idle.
maximumCapacity Number
onDemandCapacity Number: This shape is deprecated.
targetIdleCapacity Number