Class CfnContainerGroupDefinition
This data type is used with the Amazon GameLift containers feature, which is currently in public preview..
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnContainerGroupDefinition : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnContainerGroupDefinition
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.
Used with: CreateContainerGroupDefinition
Returned by: DescribeContainerGroupDefinition
, ListContainerGroupDefinitions
CloudformationResource: AWS::GameLift::ContainerGroupDefinition
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 cfnContainerGroupDefinition = new CfnContainerGroupDefinition(this, "MyCfnContainerGroupDefinition", new CfnContainerGroupDefinitionProps {
ContainerDefinitions = new [] { new ContainerDefinitionProperty {
ContainerName = "containerName",
ImageUri = "imageUri",
// the properties below are optional
Command = new [] { "command" },
Cpu = 123,
DependsOn = new [] { new ContainerDependencyProperty {
Condition = "condition",
ContainerName = "containerName"
} },
EntryPoint = new [] { "entryPoint" },
Environment = new [] { new ContainerEnvironmentProperty {
Name = "name",
Value = "value"
} },
Essential = false,
HealthCheck = new ContainerHealthCheckProperty {
Command = new [] { "command" },
// the properties below are optional
Interval = 123,
Retries = 123,
StartPeriod = 123,
Timeout = 123
},
MemoryLimits = new MemoryLimitsProperty {
HardLimit = 123,
SoftLimit = 123
},
PortConfiguration = new PortConfigurationProperty {
ContainerPortRanges = new [] { new ContainerPortRangeProperty {
FromPort = 123,
Protocol = "protocol",
ToPort = 123
} }
},
ResolvedImageDigest = "resolvedImageDigest",
WorkingDirectory = "workingDirectory"
} },
Name = "name",
OperatingSystem = "operatingSystem",
TotalCpuLimit = 123,
TotalMemoryLimit = 123,
// the properties below are optional
SchedulingStrategy = "schedulingStrategy",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnContainerGroupDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnContainerGroupDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnContainerGroupDefinition(Construct, String, ICfnContainerGroupDefinitionProps) |
Properties
AttrContainerGroupDefinitionArn | The Amazon Resource Name ( ARN ) that is assigned to an Amazon GameLift |
AttrCreationTime | A time stamp indicating when this data object was created. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ContainerDefinitions | The set of container definitions that are included in the container group. |
Name | A descriptive identifier for the container group definition. |
OperatingSystem | The platform required for all containers in the container group definition. |
SchedulingStrategy | The method for deploying the container group across fleet instances. |
Tags | An array of key-value pairs to apply to this resource. |
TotalCpuLimit | The amount of CPU units on a fleet instance to allocate for the container group. |
TotalMemoryLimit | The amount of memory (in MiB) on a fleet instance to allocate for the container group. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnContainerGroupDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnContainerGroupDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnContainerGroupDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnContainerGroupDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnContainerGroupDefinition(Construct, String, ICfnContainerGroupDefinitionProps)
public CfnContainerGroupDefinition(Construct scope, string id, ICfnContainerGroupDefinitionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnContainerGroupDefinitionProps
Resource properties.
Properties
AttrContainerGroupDefinitionArn
The Amazon Resource Name ( ARN ) that is assigned to an Amazon GameLift ContainerGroupDefinition
resource. It uniquely identifies the resource across all AWS Regions. Format is arn:aws:gamelift:<region>::containergroupdefinition/[container group definition name]
.
public virtual string AttrContainerGroupDefinitionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ContainerGroupDefinitionArn
AttrCreationTime
A time stamp indicating when this data object was created.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
Format is a number expressed in Unix time as milliseconds (for example "1469498468.057"
).
CloudformationAttribute: CreationTime
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContainerDefinitions
The set of container definitions that are included in the container group.
public virtual object ContainerDefinitions { get; set; }
Property Value
System.Object
Name
A descriptive identifier for the container group definition.
public virtual string Name { get; set; }
Property Value
System.String
OperatingSystem
The platform required for all containers in the container group definition.
public virtual string OperatingSystem { get; set; }
Property Value
System.String
SchedulingStrategy
The method for deploying the container group across fleet instances.
public virtual string SchedulingStrategy { get; set; }
Property Value
System.String
Tags
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
TotalCpuLimit
The amount of CPU units on a fleet instance to allocate for the container group.
public virtual double TotalCpuLimit { get; set; }
Property Value
System.Double
TotalMemoryLimit
The amount of memory (in MiB) on a fleet instance to allocate for the container group.
public virtual double TotalMemoryLimit { get; set; }
Property Value
System.Double
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>