software.amazon.awscdk.services.gamelift

Interface CfnFleetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.741Z")
 @Stability(value=Stable)
public interface CfnFleetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::GameLift::Fleet`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 CfnFleetProps cfnFleetProps = CfnFleetProps.builder()
         .buildId("buildId")
         .certificateConfiguration(CertificateConfigurationProperty.builder()
                 .certificateType("certificateType")
                 .build())
         .description("description")
         .desiredEc2Instances(123)
         .ec2InboundPermissions(List.of(IpPermissionProperty.builder()
                 .fromPort(123)
                 .ipRange("ipRange")
                 .protocol("protocol")
                 .toPort(123)
                 .build()))
         .ec2InstanceType("ec2InstanceType")
         .fleetType("fleetType")
         .instanceRoleArn("instanceRoleArn")
         .locations(List.of(LocationConfigurationProperty.builder()
                 .location("location")
                 // the properties below are optional
                 .locationCapacity(LocationCapacityProperty.builder()
                         .desiredEc2Instances(123)
                         .maxSize(123)
                         .minSize(123)
                         .build())
                 .build()))
         .maxSize(123)
         .metricGroups(List.of("metricGroups"))
         .minSize(123)
         .name("name")
         .newGameSessionProtectionPolicy("newGameSessionProtectionPolicy")
         .peerVpcAwsAccountId("peerVpcAwsAccountId")
         .peerVpcId("peerVpcId")
         .resourceCreationLimitPolicy(ResourceCreationLimitPolicyProperty.builder()
                 .newGameSessionsPerCreator(123)
                 .policyPeriodInMinutes(123)
                 .build())
         .runtimeConfiguration(RuntimeConfigurationProperty.builder()
                 .gameSessionActivationTimeoutSeconds(123)
                 .maxConcurrentGameSessionActivations(123)
                 .serverProcesses(List.of(ServerProcessProperty.builder()
                         .concurrentExecutions(123)
                         .launchPath("launchPath")
                         // the properties below are optional
                         .parameters("parameters")
                         .build()))
                 .build())
         .scriptId("scriptId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFleetProps.Builder A builder for CfnFleetProps
static class	CfnFleetProps.Jsii$Proxy An implementation for CfnFleetProps

Method Summary

Modifier and Type	Method and Description
static CfnFleetProps.Builder	builder()
default String	getBuildId() `AWS::GameLift::Fleet.BuildId`.
default Object	getCertificateConfiguration() `AWS::GameLift::Fleet.CertificateConfiguration`.
default String	getDescription() `AWS::GameLift::Fleet.Description`.
default Number	getDesiredEc2Instances() `AWS::GameLift::Fleet.DesiredEC2Instances`.
default Object	getEc2InboundPermissions() `AWS::GameLift::Fleet.EC2InboundPermissions`.
default String	getEc2InstanceType() `AWS::GameLift::Fleet.EC2InstanceType`.
default String	getFleetType() `AWS::GameLift::Fleet.FleetType`.
default String	getInstanceRoleArn() `AWS::GameLift::Fleet.InstanceRoleARN`.
default Object	getLocations() `AWS::GameLift::Fleet.Locations`.
default Number	getMaxSize() `AWS::GameLift::Fleet.MaxSize`.
default List<String>	getMetricGroups() `AWS::GameLift::Fleet.MetricGroups`.
default Number	getMinSize() `AWS::GameLift::Fleet.MinSize`.
default String	getName() `AWS::GameLift::Fleet.Name`.
default String	getNewGameSessionProtectionPolicy() `AWS::GameLift::Fleet.NewGameSessionProtectionPolicy`.
default String	getPeerVpcAwsAccountId() `AWS::GameLift::Fleet.PeerVpcAwsAccountId`.
default String	getPeerVpcId() `AWS::GameLift::Fleet.PeerVpcId`.
default Object	getResourceCreationLimitPolicy() `AWS::GameLift::Fleet.ResourceCreationLimitPolicy`.
default Object	getRuntimeConfiguration() `AWS::GameLift::Fleet.RuntimeConfiguration`.
default String	getScriptId() `AWS::GameLift::Fleet.ScriptId`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuildId

@Stability(value=Stable)
 @Nullable
default String getBuildId()

`AWS::GameLift::Fleet.BuildId`.

getCertificateConfiguration

@Stability(value=Stable)
 @Nullable
default Object getCertificateConfiguration()

`AWS::GameLift::Fleet.CertificateConfiguration`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::GameLift::Fleet.Description`.

getDesiredEc2Instances

@Stability(value=Stable)
 @Nullable
default Number getDesiredEc2Instances()

`AWS::GameLift::Fleet.DesiredEC2Instances`.

getEc2InboundPermissions

@Stability(value=Stable)
 @Nullable
default Object getEc2InboundPermissions()

`AWS::GameLift::Fleet.EC2InboundPermissions`.

getEc2InstanceType

@Stability(value=Stable)
 @Nullable
default String getEc2InstanceType()

`AWS::GameLift::Fleet.EC2InstanceType`.

getFleetType

@Stability(value=Stable)
 @Nullable
default String getFleetType()

`AWS::GameLift::Fleet.FleetType`.

getInstanceRoleArn

@Stability(value=Stable)
 @Nullable
default String getInstanceRoleArn()

`AWS::GameLift::Fleet.InstanceRoleARN`.

getLocations

@Stability(value=Stable)
 @Nullable
default Object getLocations()

`AWS::GameLift::Fleet.Locations`.

getMaxSize

@Stability(value=Stable)
 @Nullable
default Number getMaxSize()

`AWS::GameLift::Fleet.MaxSize`.

getMetricGroups

@Stability(value=Stable)
 @Nullable
default List<String> getMetricGroups()

`AWS::GameLift::Fleet.MetricGroups`.

getMinSize

@Stability(value=Stable)
 @Nullable
default Number getMinSize()

`AWS::GameLift::Fleet.MinSize`.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

`AWS::GameLift::Fleet.Name`.

getNewGameSessionProtectionPolicy

@Stability(value=Stable)
 @Nullable
default String getNewGameSessionProtectionPolicy()

`AWS::GameLift::Fleet.NewGameSessionProtectionPolicy`.

getPeerVpcAwsAccountId

@Stability(value=Stable)
 @Nullable
default String getPeerVpcAwsAccountId()

`AWS::GameLift::Fleet.PeerVpcAwsAccountId`.

getPeerVpcId

@Stability(value=Stable)
 @Nullable
default String getPeerVpcId()

`AWS::GameLift::Fleet.PeerVpcId`.

getResourceCreationLimitPolicy

@Stability(value=Stable)
 @Nullable
default Object getResourceCreationLimitPolicy()

`AWS::GameLift::Fleet.ResourceCreationLimitPolicy`.

getRuntimeConfiguration

@Stability(value=Stable)
 @Nullable
default Object getRuntimeConfiguration()

`AWS::GameLift::Fleet.RuntimeConfiguration`.

getScriptId

@Stability(value=Stable)
 @Nullable
default String getScriptId()

`AWS::GameLift::Fleet.ScriptId`.

builder

@Stability(value=Stable)
static CfnFleetProps.Builder builder()

Returns:

a CfnFleetProps.Builder of CfnFleetProps