Package com.pulumi.aws.gamelift

Class Fleet

  • public class Fleet
extends com.pulumi.resources.CustomResource
    Provides a GameLift Fleet resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.gamelift.Fleet;
 import com.pulumi.aws.gamelift.FleetArgs;
 import com.pulumi.aws.gamelift.inputs.FleetRuntimeConfigurationArgs;
 import com.pulumi.aws.gamelift.inputs.FleetRuntimeConfigurationServerProcessArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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) {
         var example = new Fleet("example", FleetArgs.builder()
             .runtimeConfiguration(FleetRuntimeConfigurationArgs.builder()
                 .serverProcesses(FleetRuntimeConfigurationServerProcessArgs.builder()
                     .concurrentExecutions(1)
                     .launchPath("C:\\game\\GomokuServer.exe")
                     .build())
                 .build())
             .buildId(exampleAwsGameliftBuild.id())
             .ec2InstanceType("t2.micro")
             .fleetType("ON_DEMAND")
             .name("example-fleet-name")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import GameLift Fleets using the ID. For example: ```sh $ pulumi import aws:gamelift/fleet:Fleet example <fleet-id> ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Fleet​(java.lang.String name)  
      Fleet​(java.lang.String name, FleetArgs args)  
      Fleet​(java.lang.String name, FleetArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> buildArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> buildId()  
      com.pulumi.core.Output<FleetCertificateConfiguration> certificateConfiguration()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.List<FleetEc2InboundPermission>> ec2InboundPermissions()  
      com.pulumi.core.Output<java.lang.String> ec2InstanceType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> fleetType()  
      static Fleet get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, FleetState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceRoleArn()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> logPaths()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> metricGroups()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> newGameSessionProtectionPolicy()  
      com.pulumi.core.Output<java.lang.String> operatingSystem()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<FleetResourceCreationLimitPolicy>> resourceCreationLimitPolicy()  
      com.pulumi.core.Output<java.util.Optional<FleetRuntimeConfiguration>> runtimeConfiguration()  
      com.pulumi.core.Output<java.lang.String> scriptArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> scriptId()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Fleet

        public Fleet​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Fleet

        public Fleet​(java.lang.String name,
             FleetArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Fleet

        public Fleet​(java.lang.String name,
             FleetArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Fleet ARN.

      • buildArn

        public com.pulumi.core.Output<java.lang.String> buildArn()
        Returns:
        Build ARN.

      • buildId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> buildId()
        Returns:
        ID of the GameLift Build to be deployed on the fleet. Conflicts with `scriptId`.

      • certificateConfiguration

        public com.pulumi.core.Output<FleetCertificateConfiguration> certificateConfiguration()
        Returns:
        Prompts GameLift to generate a TLS/SSL certificate for the fleet. See certificate_configuration.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Human-readable description of the fleet.

      • ec2InboundPermissions

        public com.pulumi.core.Output<java.util.List<FleetEc2InboundPermission>> ec2InboundPermissions()
        Returns:
        Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below.

      • ec2InstanceType

        public com.pulumi.core.Output<java.lang.String> ec2InstanceType()
        Returns:
        Name of an EC2 instance typeE.g., `t2.micro`

      • fleetType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> fleetType()
        Returns:
        Type of fleet. This value must be `ON_DEMAND` or `SPOT`. Defaults to `ON_DEMAND`.

      • instanceRoleArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> instanceRoleArn()
        Returns:
        ARN of an IAM role that instances in the fleet can assume.

      • logPaths

        public com.pulumi.core.Output<java.util.List<java.lang.String>> logPaths()
        Returns:
        List of paths from which the fleet captures logs.

      • metricGroups

        public com.pulumi.core.Output<java.util.List<java.lang.String>> metricGroups()
        Returns:
        List of names of metric groups to add this fleet to. A metric group tracks metrics across all fleets in the group. Defaults to `default`.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the fleet.

      • newGameSessionProtectionPolicy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> newGameSessionProtectionPolicy()
        Returns:
        Game session protection policy to apply to all instances in this fleetE.g., `FullProtection`. Defaults to `NoProtection`.

      • operatingSystem

        public com.pulumi.core.Output<java.lang.String> operatingSystem()
        Returns:
        Operating system of the fleet's computing resources.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • resourceCreationLimitPolicy

        public com.pulumi.core.Output<java.util.Optional<FleetResourceCreationLimitPolicy>> resourceCreationLimitPolicy()
        Returns:
        Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below.

      • runtimeConfiguration

        public com.pulumi.core.Output<java.util.Optional<FleetRuntimeConfiguration>> runtimeConfiguration()
        Returns:
        Instructions for launching server processes on each instance in the fleet. See below.

      • scriptArn

        public com.pulumi.core.Output<java.lang.String> scriptArn()
        Returns:
        Script ARN.

      • scriptId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> scriptId()
        Returns:
        ID of the GameLift Script to be deployed on the fleet. Conflicts with `buildId`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Fleet get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        FleetState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.