Class CfnContainerFleet

Describes an Amazon GameLift Servers managed container fleet.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnContainerFleet
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnContainerFleet : CfnResource, IInspectable, IContainerFleetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnContainerFleet Inherits CfnResource Implements IInspectable, IContainerFleetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

CloudformationResource: AWS::GameLift::ContainerFleet

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var cfnContainerFleet = new CfnContainerFleet(this, "MyCfnContainerFleet", new CfnContainerFleetProps {
                 FleetRoleArn = "fleetRoleArn",

                 // the properties below are optional
                 BillingType = "billingType",
                 DeploymentConfiguration = new DeploymentConfigurationProperty {
                     ImpairmentStrategy = "impairmentStrategy",
                     MinimumHealthyPercentage = 123,
                     ProtectionStrategy = "protectionStrategy"
                 },
                 Description = "description",
                 GameServerContainerGroupDefinitionName = "gameServerContainerGroupDefinitionName",
                 GameServerContainerGroupsPerInstance = 123,
                 GameSessionCreationLimitPolicy = new GameSessionCreationLimitPolicyProperty {
                     NewGameSessionsPerCreator = 123,
                     PolicyPeriodInMinutes = 123
                 },
                 InstanceConnectionPortRange = new ConnectionPortRangeProperty {
                     FromPort = 123,
                     ToPort = 123
                 },
                 InstanceInboundPermissions = new [] { new IpPermissionProperty {
                     FromPort = 123,
                     IpRange = "ipRange",
                     Protocol = "protocol",
                     ToPort = 123
                 } },
                 InstanceType = "instanceType",
                 Locations = new [] { new LocationConfigurationProperty {
                     Location = "location",

                     // the properties below are optional
                     LocationCapacity = new LocationCapacityProperty {
                         MaxSize = 123,
                         MinSize = 123,

                         // the properties below are optional
                         DesiredEc2Instances = 123
                     },
                     StoppedActions = new [] { "stoppedActions" }
                 } },
                 LogConfiguration = new LogConfigurationProperty {
                     LogDestination = "logDestination",
                     LogGroupArn = "logGroupArn",
                     S3BucketName = "s3BucketName"
                 },
                 MetricGroups = new [] { "metricGroups" },
                 NewGameSessionProtectionPolicy = "newGameSessionProtectionPolicy",
                 PerInstanceContainerGroupDefinitionName = "perInstanceContainerGroupDefinitionName",
                 ScalingPolicies = new [] { new ScalingPolicyProperty {
                     MetricName = "metricName",
                     Name = "name",

                     // the properties below are optional
                     ComparisonOperator = "comparisonOperator",
                     EvaluationPeriods = 123,
                     PolicyType = "policyType",
                     ScalingAdjustment = 123,
                     ScalingAdjustmentType = "scalingAdjustmentType",
                     TargetConfiguration = new TargetConfigurationProperty {
                         TargetValue = 123
                     },
                     Threshold = 123
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnContainerFleet(Construct, string, ICfnContainerFleetProps)

Describes an Amazon GameLift Servers managed container fleet.

Properties

AttrCreationTime

A time stamp indicating when this data object was created.
AttrDeploymentDetails

Provides information about the last deployment ID and its status.
AttrFleetArn

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift fleet ARN, the resource ID matches the FleetId value.
AttrFleetId

A unique identifier for the container fleet to retrieve.
AttrGameServerContainerGroupDefinitionArn

The Amazon Resource Name ( ARN ) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.
AttrMaximumGameServerContainerGroupsPerInstance

The calculated maximum number of game server container group that can be deployed on each fleet instance.
AttrPerInstanceContainerGroupDefinitionArn

The Amazon Resource Name ( ARN ) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.
AttrStatus

The current status of the container fleet.
BillingType

Indicates whether the fleet uses On-Demand or Spot instances for this fleet.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Describes an Amazon GameLift Servers managed container fleet.
ContainerFleetRef

A reference to a ContainerFleet resource.
DeploymentConfiguration

Set of rules for processing a deployment for a container fleet update.
Description

A meaningful description of the container fleet.
FleetRoleArn

The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers.
GameServerContainerGroupDefinitionName

The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.
GameServerContainerGroupsPerInstance

The number of times to replicate the game server container group on each fleet instance.
GameSessionCreationLimitPolicy

A policy that limits the number of game sessions that each individual player can create on instances in this fleet.
InstanceConnectionPortRange

The set of port numbers to open on each instance in a container fleet.
InstanceInboundPermissions

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.
InstanceType

The Amazon EC2 instance type to use for all instances in the fleet.
Locations

Describes an Amazon GameLift Servers managed container fleet.
LogConfiguration

The method that is used to collect container logs for the fleet.
MetricGroups

The name of an AWS CloudWatch metric group to add this fleet to.
NewGameSessionProtectionPolicy

Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.
PerInstanceContainerGroupDefinitionName

The name of the fleet's per-instance container group definition.
ScalingPolicies

A list of rules that control how a fleet is scaled.
Tags

An array of key-value pairs to apply to this resource.

Methods

FromFleetId(Construct, string, string)

Creates a new IContainerFleetRef from a fleetId.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Describes an Amazon GameLift Servers managed container fleet.

Constructors

CfnContainerFleet(Construct, string, ICfnContainerFleetProps)

Describes an Amazon GameLift Servers managed container fleet.

public CfnContainerFleet(Construct scope, string id, ICfnContainerFleetProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnContainerFleetProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

CloudformationResource: AWS::GameLift::ContainerFleet

ExampleMetadata: fixture=_generated

Properties

AttrCreationTime

A time stamp indicating when this data object was created.

public virtual string AttrCreationTime { get; }
Property Value

string

Remarks

Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

CloudformationAttribute: CreationTime

AttrDeploymentDetails

Provides information about the last deployment ID and its status.

public virtual IResolvable AttrDeploymentDetails { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: DeploymentDetails

AttrFleetArn

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift fleet ARN, the resource ID matches the FleetId value.

public virtual string AttrFleetArn { get; }
Property Value

string

Remarks

CloudformationAttribute: FleetArn

AttrFleetId

A unique identifier for the container fleet to retrieve.

public virtual string AttrFleetId { get; }
Property Value

string

Remarks

CloudformationAttribute: FleetId

AttrGameServerContainerGroupDefinitionArn

The Amazon Resource Name ( ARN ) that is assigned to the fleet's game server container group. The ARN value also identifies the specific container group definition version in use.

public virtual string AttrGameServerContainerGroupDefinitionArn { get; }
Property Value

string

Remarks

CloudformationAttribute: GameServerContainerGroupDefinitionArn

AttrMaximumGameServerContainerGroupsPerInstance

The calculated maximum number of game server container group that can be deployed on each fleet instance.

public virtual double AttrMaximumGameServerContainerGroupsPerInstance { get; }
Property Value

double

Remarks

The calculation depends on the resource needs of the container group and the CPU and memory resources of the fleet's instance type.

CloudformationAttribute: MaximumGameServerContainerGroupsPerInstance

AttrPerInstanceContainerGroupDefinitionArn

The Amazon Resource Name ( ARN ) that is assigned to the fleet's per-instance container group. The ARN value also identifies the specific container group definition version in use.

public virtual string AttrPerInstanceContainerGroupDefinitionArn { get; }
Property Value

string

Remarks

CloudformationAttribute: PerInstanceContainerGroupDefinitionArn

AttrStatus

The current status of the container fleet.

public virtual string AttrStatus { get; }
Property Value

string

Remarks

    CloudformationAttribute: Status

    BillingType

    Indicates whether the fleet uses On-Demand or Spot instances for this fleet.

    public virtual string? BillingType { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.

    public static string CFN_RESOURCE_TYPE_NAME { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    CdkTagManager

    Tag Manager which manages the tags for this resource.

    public virtual TagManager CdkTagManager { get; }
    Property Value

    TagManager

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    CfnProperties

    Describes an Amazon GameLift Servers managed container fleet.

    protected override IDictionary<string, object> CfnProperties { get; }
    Property Value

    IDictionary<string, object>

    Overrides
    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    ContainerFleetRef

    A reference to a ContainerFleet resource.

    public virtual IContainerFleetReference ContainerFleetRef { get; }
    Property Value

    IContainerFleetReference

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    DeploymentConfiguration

    Set of rules for processing a deployment for a container fleet update.

    public virtual object? DeploymentConfiguration { get; set; }
    Property Value

    object

    Remarks

    Type union: either IResolvable or CfnContainerFleet.IDeploymentConfigurationProperty

    Description

    A meaningful description of the container fleet.

    public virtual string? Description { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    FleetRoleArn

    The unique identifier for an AWS Identity and Access Management (IAM) role with permissions to run your containers on resources that are managed by Amazon GameLift Servers.

    public virtual string FleetRoleArn { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    GameServerContainerGroupDefinitionName

    The name of the fleet's game server container group definition, which describes how to deploy containers with your game server build and support software onto each fleet instance.

    public virtual string? GameServerContainerGroupDefinitionName { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    GameServerContainerGroupsPerInstance

    The number of times to replicate the game server container group on each fleet instance.

    public virtual double? GameServerContainerGroupsPerInstance { get; set; }
    Property Value

    double?

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    GameSessionCreationLimitPolicy

    A policy that limits the number of game sessions that each individual player can create on instances in this fleet.

    public virtual object? GameSessionCreationLimitPolicy { get; set; }
    Property Value

    object

    Remarks

    Type union: either IResolvable or CfnContainerFleet.IGameSessionCreationLimitPolicyProperty

    InstanceConnectionPortRange

    The set of port numbers to open on each instance in a container fleet.

    public virtual object? InstanceConnectionPortRange { get; set; }
    Property Value

    object

    Remarks

    Type union: either IResolvable or CfnContainerFleet.IConnectionPortRangeProperty

    InstanceInboundPermissions

    The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

    public virtual object? InstanceInboundPermissions { get; set; }
    Property Value

    object

    Remarks

    Type union: either IResolvable or (either IResolvable or CfnContainerFleet.IIpPermissionProperty)[]

    InstanceType

    The Amazon EC2 instance type to use for all instances in the fleet.

    public virtual string? InstanceType { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    Locations

    Describes an Amazon GameLift Servers managed container fleet.

    public virtual object? Locations { get; set; }
    Property Value

    object

    Remarks

    Type union: either IResolvable or (either IResolvable or CfnContainerFleet.ILocationConfigurationProperty)[]

    LogConfiguration

    The method that is used to collect container logs for the fleet.

    public virtual object? LogConfiguration { get; set; }
    Property Value

    object

    Remarks

    Type union: either IResolvable or CfnContainerFleet.ILogConfigurationProperty

    MetricGroups

    The name of an AWS CloudWatch metric group to add this fleet to.

    public virtual string[]? MetricGroups { get; set; }
    Property Value

    string[]

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    NewGameSessionProtectionPolicy

    Determines whether Amazon GameLift Servers can shut down game sessions on the fleet that are actively running and hosting players.

    public virtual string? NewGameSessionProtectionPolicy { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    PerInstanceContainerGroupDefinitionName

    The name of the fleet's per-instance container group definition.

    public virtual string? PerInstanceContainerGroupDefinitionName { get; set; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    ScalingPolicies

    A list of rules that control how a fleet is scaled.

    public virtual object? ScalingPolicies { get; set; }
    Property Value

    object

    Remarks

    Type union: either IResolvable or (either IResolvable or CfnContainerFleet.IScalingPolicyProperty)[]

    Tags

    An array of key-value pairs to apply to this resource.

    public virtual ICfnTag[]? Tags { get; set; }
    Property Value

    ICfnTag[]

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    Methods

    FromFleetId(Construct, string, string)

    Creates a new IContainerFleetRef from a fleetId.

    public static IContainerFleetRef FromFleetId(Construct scope, string id, string fleetId)
    Parameters
    scope Construct
    id string
    fleetId string
    Returns

    IContainerFleetRef

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.

    public virtual void Inspect(TreeInspector inspector)
    Parameters
    inspector TreeInspector

    tree inspector to collect and process attributes.

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    RenderProperties(IDictionary<string, object>)

    Describes an Amazon GameLift Servers managed container fleet.

    protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
    Parameters
    props IDictionary<string, object>
    Returns

    IDictionary<string, object>

    Overrides
    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containerfleet.html

    CloudformationResource: AWS::GameLift::ContainerFleet

    ExampleMetadata: fixture=_generated

    Implements

    Constructs.IConstruct
    Constructs.IDependable