CreateFleetRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.gamelift.model.GameLiftRequest
    - - software.amazon.awssdk.services.gamelift.model.CreateFleetRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFleetRequest
extends GameLiftRequest
implements ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

Represents the input for a request operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFleetRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFleetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateFleetRequest.Builder`	`builder()`
`String`	`buildId()` A unique identifier for a build to be deployed on the new fleet.
`CertificateConfiguration`	`certificateConfiguration()` Indicates whether to generate a TLS/SSL certificate for the new fleet.
`String`	`description()` A human-readable description of a fleet.
`List<IpPermission>`	`ec2InboundPermissions()` Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet.
`EC2InstanceType`	`ec2InstanceType()` The name of an EC2 instance type that is supported in Amazon GameLift.
`String`	`ec2InstanceTypeAsString()` The name of an EC2 instance type that is supported in Amazon GameLift.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FleetType`	`fleetType()` Indicates whether to use On-Demand instances or Spot instances for this fleet.
`String`	`fleetTypeAsString()` Indicates whether to use On-Demand instances or Spot instances for this fleet.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEc2InboundPermissions()` Returns true if the EC2InboundPermissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLogPaths()` Returns true if the LogPaths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasMetricGroups()` Returns true if the MetricGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`instanceRoleArn()` A unique identifier for an AWS IAM role that manages access to your AWS services.
`List<String>`	`logPaths()` This parameter is no longer used.
`List<String>`	`metricGroups()` The name of an Amazon CloudWatch metric group to add this fleet to.
`String`	`name()` A descriptive label that is associated with a fleet.
`ProtectionPolicy`	`newGameSessionProtectionPolicy()` A game session protection policy to apply to all instances in this fleet.
`String`	`newGameSessionProtectionPolicyAsString()` A game session protection policy to apply to all instances in this fleet.
`String`	`peerVpcAwsAccountId()` A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
`String`	`peerVpcId()` A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
`ResourceCreationLimitPolicy`	`resourceCreationLimitPolicy()` A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
`RuntimeConfiguration`	`runtimeConfiguration()` Instructions for launching server processes on each instance in the fleet.
`String`	`scriptId()` A unique identifier for a Realtime script to be deployed on the new fleet.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFleetRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverLaunchParameters()` This parameter is no longer used.
`String`	`serverLaunchPath()` This parameter is no longer used.
`List<Tag>`	`tags()` A list of labels to assign to the new fleet resource.
`CreateFleetRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public String name()
```
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
    
    Returns:
    
    A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
  - description
```
public String description()
```
    A human-readable description of a fleet.
    
    Returns:
    
    A human-readable description of a fleet.
  - buildId
```
public String buildId()
```
    A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
    
    Returns:
    
    A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
  - scriptId
```
public String scriptId()
```
    A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
    
    Returns:
    
    A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.
  - serverLaunchPath
```
public String serverLaunchPath()
```
    This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
    
    Returns:
    
    This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
  - serverLaunchParameters
```
public String serverLaunchParameters()
```
    This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
    
    Returns:
    
    This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
  - hasLogPaths
```
public boolean hasLogPaths()
```
    Returns true if the LogPaths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - logPaths
```
public List<String> logPaths()
```
    This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLogPaths() to see if a value was sent in this field.
    
    Returns:
    
    This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.
  - ec2InstanceType
```
public EC2InstanceType ec2InstanceType()
```
    The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
    
    If the service returns an enum value that is not available in the current SDK version, ec2InstanceType will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ec2InstanceTypeAsString().
    
    Returns:
    
    The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
    
    See Also:
    
    EC2InstanceType
  - ec2InstanceTypeAsString
```
public String ec2InstanceTypeAsString()
```
    The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
    
    If the service returns an enum value that is not available in the current SDK version, ec2InstanceType will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ec2InstanceTypeAsString().
    
    Returns:
    
    The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
    
    See Also:
    
    EC2InstanceType
  - hasEc2InboundPermissions
```
public boolean hasEc2InboundPermissions()
```
    Returns true if the EC2InboundPermissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - ec2InboundPermissions
```
public List<IpPermission> ec2InboundPermissions()
```
    Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEc2InboundPermissions() to see if a value was sent in this field.
    
    Returns:
    
    Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.
  - newGameSessionProtectionPolicy
```
public ProtectionPolicy newGameSessionProtectionPolicy()
```
    A game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
    - NoProtection - The game session can be terminated during a scale-down event.
    - FullProtection - If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
    If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().
    Returns:
    A game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
    
    NoProtection - The game session can be terminated during a scale-down event.
    
    FullProtection - If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
    See Also:
    
    ProtectionPolicy
  - newGameSessionProtectionPolicyAsString
```
public String newGameSessionProtectionPolicyAsString()
```
    A game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
    - NoProtection - The game session can be terminated during a scale-down event.
    - FullProtection - If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
    If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().
    Returns:
    A game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
    
    NoProtection - The game session can be terminated during a scale-down event.
    
    FullProtection - If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
    See Also:
    
    ProtectionPolicy
  - runtimeConfiguration
```
public RuntimeConfiguration runtimeConfiguration()
```
    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, although requests that contain values for these parameters instead of a runtime configuration will continue to work.) This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration replaced these parameters, but fleets that use them will continue to work.
    
    Returns:
    
    Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime script. The runtime configuration defines the server executables or launch script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters, although requests that contain values for these parameters instead of a runtime configuration will continue to work.) This parameter is required unless the parameters ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration replaced these parameters, but fleets that use them will continue to work.
  - resourceCreationLimitPolicy
```
public ResourceCreationLimitPolicy resourceCreationLimitPolicy()
```
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
    
    Returns:
    
    A policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
  - hasMetricGroups
```
public boolean hasMetricGroups()
```
    Returns true if the MetricGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - metricGroups
```
public List<String> metricGroups()
```
    The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMetricGroups() to see if a value was sent in this field.
    
    Returns:
    
    The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.
  - peerVpcAwsAccountId
```
public String peerVpcAwsAccountId()
```
    A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
    
    Returns:
    
    A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your account ID in the AWS Management Console under account settings.
  - peerVpcId
```
public String peerVpcId()
```
    A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
    
    Returns:
    
    A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
  - fleetType
```
public FleetType fleetType()
```
    Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
    
    If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().
    
    Returns:
    
    Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
    
    See Also:
    
    FleetType
  - fleetTypeAsString
```
public String fleetTypeAsString()
```
    Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
    
    If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().
    
    Returns:
    
    Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.
    
    See Also:
    
    FleetType
  - instanceRoleArn
```
public String instanceRoleArn()
```
    A unique identifier for an AWS IAM role that manages access to your AWS services. Fleets with an instance role ARN allow applications that are running on the fleet's instances to assume the role. Learn more about using on-box credentials for your game servers at Access external resources from a game server. To call this operation with instance role ARN, you must have IAM PassRole permissions. See IAM policy examples for GameLift.
    
    Returns:
    
    A unique identifier for an AWS IAM role that manages access to your AWS services. Fleets with an instance role ARN allow applications that are running on the fleet's instances to assume the role. Learn more about using on-box credentials for your game servers at Access external resources from a game server. To call this operation with instance role ARN, you must have IAM PassRole permissions. See IAM policy examples for GameLift.
  - certificateConfiguration
```
public CertificateConfiguration certificateConfiguration()
```
    Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication.
    
    Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
    
    Valid values include:
    - GENERATED - Generate a TLS/SSL certificate for this fleet.
    - DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
    Returns:
    Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting traffic between game clients and game servers running on GameLift. If this parameter is not specified, the default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at Securing Client/Server Communication.
    
    Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global partition but not in all other partitions. When working in a partition that does not support this feature, a request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
    
    Valid values include:
    
    GENERATED - Generate a TLS/SSL certificate for this fleet.
    
    DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public List<Tag> tags()
```
    A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
  - toBuilder
```
public CreateFleetRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
    
    Specified by:
    
    toBuilder in class GameLiftRequest
  - builder
```
public static CreateFleetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFleetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateFleetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

buildId

scriptId

serverLaunchPath

serverLaunchParameters

hasLogPaths

logPaths

ec2InstanceType

ec2InstanceTypeAsString

hasEc2InboundPermissions

ec2InboundPermissions

newGameSessionProtectionPolicy

newGameSessionProtectionPolicyAsString

runtimeConfiguration

resourceCreationLimitPolicy

hasMetricGroups

metricGroups

peerVpcAwsAccountId

peerVpcId

fleetType

fleetTypeAsString

instanceRoleArn

certificateConfiguration

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields