We recommend new projects start with resources from the AWS provider.
aws-native.gamelift.getContainerFleet
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::GameLift::ContainerFleet resource creates an Amazon GameLift (GameLift) container fleet to host game servers.
Using getContainerFleet
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 getContainerFleet(args: GetContainerFleetArgs, opts?: InvokeOptions): Promise<GetContainerFleetResult>
function getContainerFleetOutput(args: GetContainerFleetOutputArgs, opts?: InvokeOptions): Output<GetContainerFleetResult>
def get_container_fleet(fleet_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetContainerFleetResult
def get_container_fleet_output(fleet_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetContainerFleetResult]
func LookupContainerFleet(ctx *Context, args *LookupContainerFleetArgs, opts ...InvokeOption) (*LookupContainerFleetResult, error)
func LookupContainerFleetOutput(ctx *Context, args *LookupContainerFleetOutputArgs, opts ...InvokeOption) LookupContainerFleetResultOutput
> Note: This function is named LookupContainerFleet
in the Go SDK.
public static class GetContainerFleet
{
public static Task<GetContainerFleetResult> InvokeAsync(GetContainerFleetArgs args, InvokeOptions? opts = null)
public static Output<GetContainerFleetResult> Invoke(GetContainerFleetInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetContainerFleetResult> getContainerFleet(GetContainerFleetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:gamelift:getContainerFleet
arguments:
# arguments dictionary
The following arguments are supported:
- Fleet
Id string - Unique fleet ID
- Fleet
Id string - Unique fleet ID
- fleet
Id String - Unique fleet ID
- fleet
Id string - Unique fleet ID
- fleet_
id str - Unique fleet ID
- fleet
Id String - Unique fleet ID
getContainerFleet Result
The following output properties are available:
- Creation
Time string - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
- Deployment
Details Pulumi.Aws Native. Game Lift. Outputs. Container Fleet Deployment Details - Description string
- A human-readable description of a fleet.
- Fleet
Arn string - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
- Fleet
Id string - Unique fleet ID
- Fleet
Role stringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- Game
Server stringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
- Game
Session Pulumi.Creation Limit Policy Aws Native. Game Lift. Outputs. Container Fleet Game Session Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- Instance
Connection Pulumi.Port Range Aws Native. Game Lift. Outputs. Container Fleet Connection Port Range - Instance
Inbound List<Pulumi.Permissions Aws Native. Game Lift. Outputs. Container Fleet Ip Permission> - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- Log
Configuration Pulumi.Aws Native. Game Lift. Outputs. Container Fleet Log Configuration - Maximum
Game intServer Container Groups Per Instance - The maximum number of game server container groups per instance, a number between 1-5000.
- Metric
Groups List<string> - The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
- New
Game Pulumi.Session Protection Policy Aws Native. Game Lift. Container Fleet New Game Session Protection Policy - A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
- Per
Instance stringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
- Status
Pulumi.
Aws Native. Game Lift. Container Fleet Status - The current status of the container fleet.
- List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs to apply to this resource.
- Creation
Time string - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
- Deployment
Details ContainerFleet Deployment Details - Description string
- A human-readable description of a fleet.
- Fleet
Arn string - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
- Fleet
Id string - Unique fleet ID
- Fleet
Role stringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- Game
Server stringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
- Game
Session ContainerCreation Limit Policy Fleet Game Session Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- Instance
Connection ContainerPort Range Fleet Connection Port Range - Instance
Inbound []ContainerPermissions Fleet Ip Permission - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- Log
Configuration ContainerFleet Log Configuration - Maximum
Game intServer Container Groups Per Instance - The maximum number of game server container groups per instance, a number between 1-5000.
- Metric
Groups []string - The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
- New
Game ContainerSession Protection Policy Fleet New Game Session Protection Policy - A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
- Per
Instance stringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
- Status
Container
Fleet Status - The current status of the container fleet.
- Tag
- An array of key-value pairs to apply to this resource.
- creation
Time String - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
- deployment
Details ContainerFleet Deployment Details - description String
- A human-readable description of a fleet.
- fleet
Arn String - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
- fleet
Id String - Unique fleet ID
- fleet
Role StringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- game
Server StringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
- game
Session ContainerCreation Limit Policy Fleet Game Session Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- instance
Connection ContainerPort Range Fleet Connection Port Range - instance
Inbound List<ContainerPermissions Fleet Ip Permission> - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- log
Configuration ContainerFleet Log Configuration - maximum
Game IntegerServer Container Groups Per Instance - The maximum number of game server container groups per instance, a number between 1-5000.
- metric
Groups List<String> - The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
- new
Game ContainerSession Protection Policy Fleet New Game Session Protection Policy - A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
- per
Instance StringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
- status
Container
Fleet Status - The current status of the container fleet.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- creation
Time string - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
- deployment
Details ContainerFleet Deployment Details - description string
- A human-readable description of a fleet.
- fleet
Arn string - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
- fleet
Id string - Unique fleet ID
- fleet
Role stringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- game
Server stringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
- game
Session ContainerCreation Limit Policy Fleet Game Session Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- instance
Connection ContainerPort Range Fleet Connection Port Range - instance
Inbound ContainerPermissions Fleet Ip Permission[] - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- log
Configuration ContainerFleet Log Configuration - maximum
Game numberServer Container Groups Per Instance - The maximum number of game server container groups per instance, a number between 1-5000.
- metric
Groups string[] - The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
- new
Game ContainerSession Protection Policy Fleet New Game Session Protection Policy - A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
- per
Instance stringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
- status
Container
Fleet Status - The current status of the container fleet.
- Tag[]
- An array of key-value pairs to apply to this resource.
- creation_
time str - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
- deployment_
details ContainerFleet Deployment Details - description str
- A human-readable description of a fleet.
- fleet_
arn str - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
- fleet_
id str - Unique fleet ID
- fleet_
role_ strarn - A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- game_
server_ strcontainer_ group_ definition_ arn - The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
- game_
session_ Containercreation_ limit_ policy Fleet Game Session Creation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- instance_
connection_ Containerport_ range Fleet Connection Port Range - instance_
inbound_ Sequence[Containerpermissions Fleet Ip Permission] - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- log_
configuration ContainerFleet Log Configuration - maximum_
game_ intserver_ container_ groups_ per_ instance - The maximum number of game server container groups per instance, a number between 1-5000.
- metric_
groups Sequence[str] - The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
- new_
game_ Containersession_ protection_ policy Fleet New Game Session Protection Policy - A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
- per_
instance_ strcontainer_ group_ definition_ arn - The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
- status
Container
Fleet Status - The current status of the container fleet.
- Sequence[root_Tag]
- An array of key-value pairs to apply to this resource.
- creation
Time String - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
- deployment
Details Property Map - description String
- A human-readable description of a fleet.
- fleet
Arn String - The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
- fleet
Id String - Unique fleet ID
- fleet
Role StringArn - A unique identifier for an AWS IAM role that manages access to your AWS services. Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console.
- game
Server StringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
- game
Session Property MapCreation Limit Policy - A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
- instance
Connection Property MapPort Range - instance
Inbound List<Property Map>Permissions - A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
- log
Configuration Property Map - maximum
Game NumberServer Container Groups Per Instance - The maximum number of game server container groups per instance, a number between 1-5000.
- metric
Groups List<String> - The name of an Amazon CloudWatch metric group. A metric group aggregates the metrics for all fleets in the group. Specify a string containing the metric group name. You can use an existing name or use a new name to create a new metric group. Currently, this parameter can have only one string.
- new
Game "FullSession Protection Policy Protection" | "No Protection" - A game session protection policy to apply to all game sessions hosted on instances in this fleet. When protected, active game sessions cannot be terminated during a scale-down event. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy to affect future game sessions on the fleet. You can also set protection for individual game sessions.
- per
Instance StringContainer Group Definition Arn - The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
- status "PENDING" | "CREATING" | "CREATED" | "ACTIVATING" | "ACTIVE" | "UPDATING" | "DELETING"
- The current status of the container fleet.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
Supporting Types
ContainerFleetConnectionPortRange
ContainerFleetDeploymentDetails
- Latest
Deployment stringId - The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
- Latest
Deployment stringId - The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
- latest
Deployment StringId - The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
- latest
Deployment stringId - The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
- latest_
deployment_ strid - The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
- latest
Deployment StringId - The ID of the last deployment on the container fleet. This field will be empty if the container fleet does not have a ContainerGroupDefinition attached.
ContainerFleetGameSessionCreationLimitPolicy
- New
Game intSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- Policy
Period intIn Minutes - The time span used in evaluating the resource creation limit policy.
- New
Game intSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- Policy
Period intIn Minutes - The time span used in evaluating the resource creation limit policy.
- new
Game IntegerSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period IntegerIn Minutes - The time span used in evaluating the resource creation limit policy.
- new
Game numberSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period numberIn Minutes - The time span used in evaluating the resource creation limit policy.
- new_
game_ intsessions_ per_ creator - The maximum number of game sessions that an individual can create during the policy period.
- policy_
period_ intin_ minutes - The time span used in evaluating the resource creation limit policy.
- new
Game NumberSessions Per Creator - The maximum number of game sessions that an individual can create during the policy period.
- policy
Period NumberIn Minutes - The time span used in evaluating the resource creation limit policy.
ContainerFleetIpPermission
- From
Port int - A starting value for a range of allowed port numbers.
- Ip
Range string - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- Protocol
Pulumi.
Aws Native. Game Lift. Container Fleet Ip Permission Protocol - The network communication protocol used by the fleet.
- To
Port int - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- From
Port int - A starting value for a range of allowed port numbers.
- Ip
Range string - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- Protocol
Container
Fleet Ip Permission Protocol - The network communication protocol used by the fleet.
- To
Port int - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from
Port Integer - A starting value for a range of allowed port numbers.
- ip
Range String - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol
Container
Fleet Ip Permission Protocol - The network communication protocol used by the fleet.
- to
Port Integer - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from
Port number - A starting value for a range of allowed port numbers.
- ip
Range string - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol
Container
Fleet Ip Permission Protocol - The network communication protocol used by the fleet.
- to
Port number - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from_
port int - A starting value for a range of allowed port numbers.
- ip_
range str - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol
Container
Fleet Ip Permission Protocol - The network communication protocol used by the fleet.
- to_
port int - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
- from
Port Number - A starting value for a range of allowed port numbers.
- ip
Range String - A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".
- protocol "TCP" | "UDP"
- The network communication protocol used by the fleet.
- to
Port Number - An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
ContainerFleetIpPermissionProtocol
ContainerFleetLogConfiguration
- Log
Destination Pulumi.Aws Native. Game Lift. Container Fleet Log Destination - S3Bucket
Name string - The name of the S3 bucket to pull logs from if S3 is the LogDestination
- Log
Destination ContainerFleet Log Destination - S3Bucket
Name string - The name of the S3 bucket to pull logs from if S3 is the LogDestination
- log
Destination ContainerFleet Log Destination - s3Bucket
Name String - The name of the S3 bucket to pull logs from if S3 is the LogDestination
- log
Destination ContainerFleet Log Destination - s3Bucket
Name string - The name of the S3 bucket to pull logs from if S3 is the LogDestination
- log_
destination ContainerFleet Log Destination - s3_
bucket_ strname - The name of the S3 bucket to pull logs from if S3 is the LogDestination
- log
Destination "NONE" | "CLOUDWATCH" | "S3" - s3Bucket
Name String - The name of the S3 bucket to pull logs from if S3 is the LogDestination
ContainerFleetLogDestination
ContainerFleetNewGameSessionProtectionPolicy
ContainerFleetStatus
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.