1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. gamelift
  5. getContainerFleet

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.gamelift.getContainerFleet

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    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:

    FleetId string
    Unique fleet ID
    FleetId string
    Unique fleet ID
    fleetId String
    Unique fleet ID
    fleetId string
    Unique fleet ID
    fleet_id str
    Unique fleet ID
    fleetId String
    Unique fleet ID

    getContainerFleet Result

    The following output properties are available:

    CreationTime 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").
    DeploymentDetails Pulumi.AwsNative.GameLift.Outputs.ContainerFleetDeploymentDetails
    Description string
    A human-readable description of a fleet.
    FleetArn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
    FleetId string
    Unique fleet ID
    FleetRoleArn string
    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.
    GameServerContainerGroupDefinitionArn string
    The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
    GameSessionCreationLimitPolicy Pulumi.AwsNative.GameLift.Outputs.ContainerFleetGameSessionCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    InstanceConnectionPortRange Pulumi.AwsNative.GameLift.Outputs.ContainerFleetConnectionPortRange
    InstanceInboundPermissions List<Pulumi.AwsNative.GameLift.Outputs.ContainerFleetIpPermission>
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    LogConfiguration Pulumi.AwsNative.GameLift.Outputs.ContainerFleetLogConfiguration
    MaximumGameServerContainerGroupsPerInstance int
    The maximum number of game server container groups per instance, a number between 1-5000.
    MetricGroups 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.
    NewGameSessionProtectionPolicy Pulumi.AwsNative.GameLift.ContainerFleetNewGameSessionProtectionPolicy
    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.
    PerInstanceContainerGroupDefinitionArn string
    The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
    Status Pulumi.AwsNative.GameLift.ContainerFleetStatus
    The current status of the container fleet.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    CreationTime 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").
    DeploymentDetails ContainerFleetDeploymentDetails
    Description string
    A human-readable description of a fleet.
    FleetArn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
    FleetId string
    Unique fleet ID
    FleetRoleArn string
    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.
    GameServerContainerGroupDefinitionArn string
    The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
    GameSessionCreationLimitPolicy ContainerFleetGameSessionCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    InstanceConnectionPortRange ContainerFleetConnectionPortRange
    InstanceInboundPermissions []ContainerFleetIpPermission
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    LogConfiguration ContainerFleetLogConfiguration
    MaximumGameServerContainerGroupsPerInstance int
    The maximum number of game server container groups per instance, a number between 1-5000.
    MetricGroups []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.
    NewGameSessionProtectionPolicy ContainerFleetNewGameSessionProtectionPolicy
    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.
    PerInstanceContainerGroupDefinitionArn string
    The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
    Status ContainerFleetStatus
    The current status of the container fleet.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    creationTime 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").
    deploymentDetails ContainerFleetDeploymentDetails
    description String
    A human-readable description of a fleet.
    fleetArn String
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
    fleetId String
    Unique fleet ID
    fleetRoleArn String
    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.
    gameServerContainerGroupDefinitionArn String
    The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
    gameSessionCreationLimitPolicy ContainerFleetGameSessionCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    instanceConnectionPortRange ContainerFleetConnectionPortRange
    instanceInboundPermissions List<ContainerFleetIpPermission>
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    logConfiguration ContainerFleetLogConfiguration
    maximumGameServerContainerGroupsPerInstance Integer
    The maximum number of game server container groups per instance, a number between 1-5000.
    metricGroups 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.
    newGameSessionProtectionPolicy ContainerFleetNewGameSessionProtectionPolicy
    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.
    perInstanceContainerGroupDefinitionArn String
    The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
    status ContainerFleetStatus
    The current status of the container fleet.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    creationTime 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").
    deploymentDetails ContainerFleetDeploymentDetails
    description string
    A human-readable description of a fleet.
    fleetArn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
    fleetId string
    Unique fleet ID
    fleetRoleArn string
    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.
    gameServerContainerGroupDefinitionArn string
    The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
    gameSessionCreationLimitPolicy ContainerFleetGameSessionCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    instanceConnectionPortRange ContainerFleetConnectionPortRange
    instanceInboundPermissions ContainerFleetIpPermission[]
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    logConfiguration ContainerFleetLogConfiguration
    maximumGameServerContainerGroupsPerInstance number
    The maximum number of game server container groups per instance, a number between 1-5000.
    metricGroups 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.
    newGameSessionProtectionPolicy ContainerFleetNewGameSessionProtectionPolicy
    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.
    perInstanceContainerGroupDefinitionArn string
    The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
    status ContainerFleetStatus
    The current status of the container fleet.
    tags 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 ContainerFleetDeploymentDetails
    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_arn str
    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_container_group_definition_arn str
    The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
    game_session_creation_limit_policy ContainerFleetGameSessionCreationLimitPolicy
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    instance_connection_port_range ContainerFleetConnectionPortRange
    instance_inbound_permissions Sequence[ContainerFleetIpPermission]
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    log_configuration ContainerFleetLogConfiguration
    maximum_game_server_container_groups_per_instance int
    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_session_protection_policy ContainerFleetNewGameSessionProtectionPolicy
    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_container_group_definition_arn str
    The Amazon Resource Name (ARN) of the per instance container group definition. This field will be empty if PerInstanceContainerGroupDefinitionName is not specified.
    status ContainerFleetStatus
    The current status of the container fleet.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    creationTime 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").
    deploymentDetails Property Map
    description String
    A human-readable description of a fleet.
    fleetArn String
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift container fleet resource and uniquely identifies it across all AWS Regions.
    fleetId String
    Unique fleet ID
    fleetRoleArn String
    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.
    gameServerContainerGroupDefinitionArn String
    The Amazon Resource Name (ARN) of the game server container group definition. This field will be empty if GameServerContainerGroupDefinitionName is not specified.
    gameSessionCreationLimitPolicy Property Map
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    instanceConnectionPortRange Property Map
    instanceInboundPermissions List<Property Map>
    A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift server.
    logConfiguration Property Map
    maximumGameServerContainerGroupsPerInstance Number
    The maximum number of game server container groups per instance, a number between 1-5000.
    metricGroups 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.
    newGameSessionProtectionPolicy "FullProtection" | "NoProtection"
    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.
    perInstanceContainerGroupDefinitionArn String
    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.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    ContainerFleetConnectionPortRange

    FromPort int
    A starting value for a range of allowed port numbers.
    ToPort int
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    FromPort int
    A starting value for a range of allowed port numbers.
    ToPort int
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    fromPort Integer
    A starting value for a range of allowed port numbers.
    toPort Integer
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    fromPort number
    A starting value for a range of allowed port numbers.
    toPort 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.
    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.
    fromPort Number
    A starting value for a range of allowed port numbers.
    toPort Number
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

    ContainerFleetDeploymentDetails

    LatestDeploymentId string
    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.
    LatestDeploymentId string
    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.
    latestDeploymentId String
    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.
    latestDeploymentId string
    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_id str
    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.
    latestDeploymentId String
    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

    NewGameSessionsPerCreator int
    The maximum number of game sessions that an individual can create during the policy period.
    PolicyPeriodInMinutes int
    The time span used in evaluating the resource creation limit policy.
    NewGameSessionsPerCreator int
    The maximum number of game sessions that an individual can create during the policy period.
    PolicyPeriodInMinutes int
    The time span used in evaluating the resource creation limit policy.
    newGameSessionsPerCreator Integer
    The maximum number of game sessions that an individual can create during the policy period.
    policyPeriodInMinutes Integer
    The time span used in evaluating the resource creation limit policy.
    newGameSessionsPerCreator number
    The maximum number of game sessions that an individual can create during the policy period.
    policyPeriodInMinutes number
    The time span used in evaluating the resource creation limit policy.
    new_game_sessions_per_creator int
    The maximum number of game sessions that an individual can create during the policy period.
    policy_period_in_minutes int
    The time span used in evaluating the resource creation limit policy.
    newGameSessionsPerCreator Number
    The maximum number of game sessions that an individual can create during the policy period.
    policyPeriodInMinutes Number
    The time span used in evaluating the resource creation limit policy.

    ContainerFleetIpPermission

    FromPort int
    A starting value for a range of allowed port numbers.
    IpRange 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.AwsNative.GameLift.ContainerFleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    ToPort int
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    FromPort int
    A starting value for a range of allowed port numbers.
    IpRange 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 ContainerFleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    ToPort int
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    fromPort Integer
    A starting value for a range of allowed port numbers.
    ipRange 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 ContainerFleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    toPort Integer
    An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
    fromPort number
    A starting value for a range of allowed port numbers.
    ipRange 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 ContainerFleetIpPermissionProtocol
    The network communication protocol used by the fleet.
    toPort 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 ContainerFleetIpPermissionProtocol
    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.
    fromPort Number
    A starting value for a range of allowed port numbers.
    ipRange 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.
    toPort 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

    LogDestination Pulumi.AwsNative.GameLift.ContainerFleetLogDestination
    S3BucketName string
    The name of the S3 bucket to pull logs from if S3 is the LogDestination
    LogDestination ContainerFleetLogDestination
    S3BucketName string
    The name of the S3 bucket to pull logs from if S3 is the LogDestination
    logDestination ContainerFleetLogDestination
    s3BucketName String
    The name of the S3 bucket to pull logs from if S3 is the LogDestination
    logDestination ContainerFleetLogDestination
    s3BucketName string
    The name of the S3 bucket to pull logs from if S3 is the LogDestination
    log_destination ContainerFleetLogDestination
    s3_bucket_name str
    The name of the S3 bucket to pull logs from if S3 is the LogDestination
    logDestination "NONE" | "CLOUDWATCH" | "S3"
    s3BucketName String
    The name of the S3 bucket to pull logs from if S3 is the LogDestination

    ContainerFleetLogDestination

    ContainerFleetNewGameSessionProtectionPolicy

    ContainerFleetStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi