github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/gamelift/gameSessionQueue.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package gamelift

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Provides an GameLift Game Session Queue resource.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/gamelift"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := gamelift.NewGameSessionQueue(ctx, "test", &gamelift.GameSessionQueueArgs{
//				Name: pulumi.String("example-session-queue"),
//				Destinations: pulumi.StringArray{
//					usWest2Fleet.Arn,
//					euCentral1Fleet.Arn,
//				},
//				NotificationTarget: pulumi.Any(gameSessionQueueNotifications.Arn),
//				PlayerLatencyPolicies: gamelift.GameSessionQueuePlayerLatencyPolicyArray{
//					&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
//						MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(100),
//						PolicyDurationSeconds:                      pulumi.Int(5),
//					},
//					&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
//						MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(200),
//					},
//				},
//				TimeoutInSeconds: pulumi.Int(60),
//			})
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
//
// ## Import
//
// Using `pulumi import`, import GameLift Game Session Queues using their `name`. For example:
//
// ```sh
// $ pulumi import aws:gamelift/gameSessionQueue:GameSessionQueue example example
// ```
type GameSessionQueue struct {
	pulumi.CustomResourceState

	// Game Session Queue ARN.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Information to be added to all events that are related to this game session queue.
	CustomEventData pulumi.StringPtrOutput `pulumi:"customEventData"`
	// List of fleet/alias ARNs used by session queue for placing game sessions.
	Destinations pulumi.StringArrayOutput `pulumi:"destinations"`
	// Name of the session queue.
	Name pulumi.StringOutput `pulumi:"name"`
	// An SNS topic ARN that is set up to receive game session placement notifications.
	NotificationTarget pulumi.StringPtrOutput `pulumi:"notificationTarget"`
	// One or more policies used to choose fleet based on player latency. See below.
	PlayerLatencyPolicies GameSessionQueuePlayerLatencyPolicyArrayOutput `pulumi:"playerLatencyPolicies"`
	// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// Maximum time a game session request can remain in the queue.
	TimeoutInSeconds pulumi.IntPtrOutput `pulumi:"timeoutInSeconds"`
}

// NewGameSessionQueue registers a new resource with the given unique name, arguments, and options.
func NewGameSessionQueue(ctx *pulumi.Context,
	name string, args *GameSessionQueueArgs, opts ...pulumi.ResourceOption) (*GameSessionQueue, error) {
	if args == nil {
		args = &GameSessionQueueArgs{}
	}

	opts = internal.PkgResourceDefaultOpts(opts)
	var resource GameSessionQueue
	err := ctx.RegisterResource("aws:gamelift/gameSessionQueue:GameSessionQueue", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetGameSessionQueue gets an existing GameSessionQueue resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetGameSessionQueue(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *GameSessionQueueState, opts ...pulumi.ResourceOption) (*GameSessionQueue, error) {
	var resource GameSessionQueue
	err := ctx.ReadResource("aws:gamelift/gameSessionQueue:GameSessionQueue", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering GameSessionQueue resources.
type gameSessionQueueState struct {
	// Game Session Queue ARN.
	Arn *string `pulumi:"arn"`
	// Information to be added to all events that are related to this game session queue.
	CustomEventData *string `pulumi:"customEventData"`
	// List of fleet/alias ARNs used by session queue for placing game sessions.
	Destinations []string `pulumi:"destinations"`
	// Name of the session queue.
	Name *string `pulumi:"name"`
	// An SNS topic ARN that is set up to receive game session placement notifications.
	NotificationTarget *string `pulumi:"notificationTarget"`
	// One or more policies used to choose fleet based on player latency. See below.
	PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicy `pulumi:"playerLatencyPolicies"`
	// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags map[string]string `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll map[string]string `pulumi:"tagsAll"`
	// Maximum time a game session request can remain in the queue.
	TimeoutInSeconds *int `pulumi:"timeoutInSeconds"`
}

type GameSessionQueueState struct {
	// Game Session Queue ARN.
	Arn pulumi.StringPtrInput
	// Information to be added to all events that are related to this game session queue.
	CustomEventData pulumi.StringPtrInput
	// List of fleet/alias ARNs used by session queue for placing game sessions.
	Destinations pulumi.StringArrayInput
	// Name of the session queue.
	Name pulumi.StringPtrInput
	// An SNS topic ARN that is set up to receive game session placement notifications.
	NotificationTarget pulumi.StringPtrInput
	// One or more policies used to choose fleet based on player latency. See below.
	PlayerLatencyPolicies GameSessionQueuePlayerLatencyPolicyArrayInput
	// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
	// Maximum time a game session request can remain in the queue.
	TimeoutInSeconds pulumi.IntPtrInput
}

func (GameSessionQueueState) ElementType() reflect.Type {
	return reflect.TypeOf((*gameSessionQueueState)(nil)).Elem()
}

type gameSessionQueueArgs struct {
	// Information to be added to all events that are related to this game session queue.
	CustomEventData *string `pulumi:"customEventData"`
	// List of fleet/alias ARNs used by session queue for placing game sessions.
	Destinations []string `pulumi:"destinations"`
	// Name of the session queue.
	Name *string `pulumi:"name"`
	// An SNS topic ARN that is set up to receive game session placement notifications.
	NotificationTarget *string `pulumi:"notificationTarget"`
	// One or more policies used to choose fleet based on player latency. See below.
	PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicy `pulumi:"playerLatencyPolicies"`
	// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags map[string]string `pulumi:"tags"`
	// Maximum time a game session request can remain in the queue.
	TimeoutInSeconds *int `pulumi:"timeoutInSeconds"`
}

// The set of arguments for constructing a GameSessionQueue resource.
type GameSessionQueueArgs struct {
	// Information to be added to all events that are related to this game session queue.
	CustomEventData pulumi.StringPtrInput
	// List of fleet/alias ARNs used by session queue for placing game sessions.
	Destinations pulumi.StringArrayInput
	// Name of the session queue.
	Name pulumi.StringPtrInput
	// An SNS topic ARN that is set up to receive game session placement notifications.
	NotificationTarget pulumi.StringPtrInput
	// One or more policies used to choose fleet based on player latency. See below.
	PlayerLatencyPolicies GameSessionQueuePlayerLatencyPolicyArrayInput
	// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// Maximum time a game session request can remain in the queue.
	TimeoutInSeconds pulumi.IntPtrInput
}

func (GameSessionQueueArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*gameSessionQueueArgs)(nil)).Elem()
}

type GameSessionQueueInput interface {
	pulumi.Input

	ToGameSessionQueueOutput() GameSessionQueueOutput
	ToGameSessionQueueOutputWithContext(ctx context.Context) GameSessionQueueOutput
}

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

func (i *GameSessionQueue) ToGameSessionQueueOutput() GameSessionQueueOutput {
	return i.ToGameSessionQueueOutputWithContext(context.Background())
}

func (i *GameSessionQueue) ToGameSessionQueueOutputWithContext(ctx context.Context) GameSessionQueueOutput {
	return pulumi.ToOutputWithContext(ctx, i).(GameSessionQueueOutput)
}

// GameSessionQueueArrayInput is an input type that accepts GameSessionQueueArray and GameSessionQueueArrayOutput values.
// You can construct a concrete instance of `GameSessionQueueArrayInput` via:
//
//	GameSessionQueueArray{ GameSessionQueueArgs{...} }
type GameSessionQueueArrayInput interface {
	pulumi.Input

	ToGameSessionQueueArrayOutput() GameSessionQueueArrayOutput
	ToGameSessionQueueArrayOutputWithContext(context.Context) GameSessionQueueArrayOutput
}

type GameSessionQueueArray []GameSessionQueueInput

func (GameSessionQueueArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*GameSessionQueue)(nil)).Elem()
}

func (i GameSessionQueueArray) ToGameSessionQueueArrayOutput() GameSessionQueueArrayOutput {
	return i.ToGameSessionQueueArrayOutputWithContext(context.Background())
}

func (i GameSessionQueueArray) ToGameSessionQueueArrayOutputWithContext(ctx context.Context) GameSessionQueueArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(GameSessionQueueArrayOutput)
}

// GameSessionQueueMapInput is an input type that accepts GameSessionQueueMap and GameSessionQueueMapOutput values.
// You can construct a concrete instance of `GameSessionQueueMapInput` via:
//
//	GameSessionQueueMap{ "key": GameSessionQueueArgs{...} }
type GameSessionQueueMapInput interface {
	pulumi.Input

	ToGameSessionQueueMapOutput() GameSessionQueueMapOutput
	ToGameSessionQueueMapOutputWithContext(context.Context) GameSessionQueueMapOutput
}

type GameSessionQueueMap map[string]GameSessionQueueInput

func (GameSessionQueueMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*GameSessionQueue)(nil)).Elem()
}

func (i GameSessionQueueMap) ToGameSessionQueueMapOutput() GameSessionQueueMapOutput {
	return i.ToGameSessionQueueMapOutputWithContext(context.Background())
}

func (i GameSessionQueueMap) ToGameSessionQueueMapOutputWithContext(ctx context.Context) GameSessionQueueMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(GameSessionQueueMapOutput)
}

type GameSessionQueueOutput struct{ *pulumi.OutputState }

func (GameSessionQueueOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**GameSessionQueue)(nil)).Elem()
}

func (o GameSessionQueueOutput) ToGameSessionQueueOutput() GameSessionQueueOutput {
	return o
}

func (o GameSessionQueueOutput) ToGameSessionQueueOutputWithContext(ctx context.Context) GameSessionQueueOutput {
	return o
}

// Game Session Queue ARN.
func (o GameSessionQueueOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.StringOutput { return v.Arn }).(pulumi.StringOutput)
}

// Information to be added to all events that are related to this game session queue.
func (o GameSessionQueueOutput) CustomEventData() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.StringPtrOutput { return v.CustomEventData }).(pulumi.StringPtrOutput)
}

// List of fleet/alias ARNs used by session queue for placing game sessions.
func (o GameSessionQueueOutput) Destinations() pulumi.StringArrayOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.StringArrayOutput { return v.Destinations }).(pulumi.StringArrayOutput)
}

// Name of the session queue.
func (o GameSessionQueueOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.StringOutput { return v.Name }).(pulumi.StringOutput)
}

// An SNS topic ARN that is set up to receive game session placement notifications.
func (o GameSessionQueueOutput) NotificationTarget() pulumi.StringPtrOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.StringPtrOutput { return v.NotificationTarget }).(pulumi.StringPtrOutput)
}

// One or more policies used to choose fleet based on player latency. See below.
func (o GameSessionQueueOutput) PlayerLatencyPolicies() GameSessionQueuePlayerLatencyPolicyArrayOutput {
	return o.ApplyT(func(v *GameSessionQueue) GameSessionQueuePlayerLatencyPolicyArrayOutput {
		return v.PlayerLatencyPolicies
	}).(GameSessionQueuePlayerLatencyPolicyArrayOutput)
}

// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (o GameSessionQueueOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.StringMapOutput { return v.Tags }).(pulumi.StringMapOutput)
}

// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
//
// Deprecated: Please use `tags` instead.
func (o GameSessionQueueOutput) TagsAll() pulumi.StringMapOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.StringMapOutput { return v.TagsAll }).(pulumi.StringMapOutput)
}

// Maximum time a game session request can remain in the queue.
func (o GameSessionQueueOutput) TimeoutInSeconds() pulumi.IntPtrOutput {
	return o.ApplyT(func(v *GameSessionQueue) pulumi.IntPtrOutput { return v.TimeoutInSeconds }).(pulumi.IntPtrOutput)
}

type GameSessionQueueArrayOutput struct{ *pulumi.OutputState }

func (GameSessionQueueArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*GameSessionQueue)(nil)).Elem()
}

func (o GameSessionQueueArrayOutput) ToGameSessionQueueArrayOutput() GameSessionQueueArrayOutput {
	return o
}

func (o GameSessionQueueArrayOutput) ToGameSessionQueueArrayOutputWithContext(ctx context.Context) GameSessionQueueArrayOutput {
	return o
}

func (o GameSessionQueueArrayOutput) Index(i pulumi.IntInput) GameSessionQueueOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *GameSessionQueue {
		return vs[0].([]*GameSessionQueue)[vs[1].(int)]
	}).(GameSessionQueueOutput)
}

type GameSessionQueueMapOutput struct{ *pulumi.OutputState }

func (GameSessionQueueMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*GameSessionQueue)(nil)).Elem()
}

func (o GameSessionQueueMapOutput) ToGameSessionQueueMapOutput() GameSessionQueueMapOutput {
	return o
}

func (o GameSessionQueueMapOutput) ToGameSessionQueueMapOutputWithContext(ctx context.Context) GameSessionQueueMapOutput {
	return o
}

func (o GameSessionQueueMapOutput) MapIndex(k pulumi.StringInput) GameSessionQueueOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *GameSessionQueue {
		return vs[0].(map[string]*GameSessionQueue)[vs[1].(string)]
	}).(GameSessionQueueOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*GameSessionQueueInput)(nil)).Elem(), &GameSessionQueue{})
	pulumi.RegisterInputType(reflect.TypeOf((*GameSessionQueueArrayInput)(nil)).Elem(), GameSessionQueueArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*GameSessionQueueMapInput)(nil)).Elem(), GameSessionQueueMap{})
	pulumi.RegisterOutputType(GameSessionQueueOutput{})
	pulumi.RegisterOutputType(GameSessionQueueArrayOutput{})
	pulumi.RegisterOutputType(GameSessionQueueMapOutput{})
}