Class CfnContainerGroupDefinition
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gamelift.CfnContainerGroupDefinition
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-07-12T19:34:02.494Z")
@Stability(Stable)
public class CfnContainerGroupDefinition
extends CfnResource
implements IInspectable, ITaggableV2
This data type is used with the Amazon GameLift containers feature, which is currently in public preview..
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
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.*; CfnContainerGroupDefinition cfnContainerGroupDefinition = CfnContainerGroupDefinition.Builder.create(this, "MyCfnContainerGroupDefinition") .containerDefinitions(List.of(ContainerDefinitionProperty.builder() .containerName("containerName") .imageUri("imageUri") // the properties below are optional .command(List.of("command")) .cpu(123) .dependsOn(List.of(ContainerDependencyProperty.builder() .condition("condition") .containerName("containerName") .build())) .entryPoint(List.of("entryPoint")) .environment(List.of(ContainerEnvironmentProperty.builder() .name("name") .value("value") .build())) .essential(false) .healthCheck(ContainerHealthCheckProperty.builder() .command(List.of("command")) // the properties below are optional .interval(123) .retries(123) .startPeriod(123) .timeout(123) .build()) .memoryLimits(MemoryLimitsProperty.builder() .hardLimit(123) .softLimit(123) .build()) .portConfiguration(PortConfigurationProperty.builder() .containerPortRanges(List.of(ContainerPortRangeProperty.builder() .fromPort(123) .protocol("protocol") .toPort(123) .build())) .build()) .resolvedImageDigest("resolvedImageDigest") .workingDirectory("workingDirectory") .build())) .name("name") .operatingSystem("operatingSystem") .totalCpuLimit(123) .totalMemoryLimit(123) // the properties below are optional .schedulingStrategy("schedulingStrategy") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnContainerGroupDefinition
.static interface
This data type is used with the Amazon GameLift containers feature, which is currently in public preview..static interface
This data type is used with the Amazon GameLift containers feature, which is currently in public preview..static interface
This data type is used with the Amazon GameLift containers feature, which is currently in public preview..static interface
Instructions on when and how to check the health of a container in a container fleet.static interface
This data type is used with the Amazon GameLift containers feature, which is currently in public preview..static interface
Specifies how much memory is available to the container.static interface
Defines the ports on a container.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnContainerGroupDefinition
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnContainerGroupDefinition
(software.amazon.jsii.JsiiObjectRef objRef) CfnContainerGroupDefinition
(software.constructs.Construct scope, String id, CfnContainerGroupDefinitionProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name ( ARN ) that is assigned to an Amazon GameLiftContainerGroupDefinition
resource.A time stamp indicating when this data object was created.Tag Manager which manages the tags for this resource.The set of container definitions that are included in the container group.getName()
A descriptive identifier for the container group definition.The platform required for all containers in the container group definition.The method for deploying the container group across fleet instances.getTags()
An array of key-value pairs to apply to this resource.The amount of CPU units on a fleet instance to allocate for the container group.The amount of memory (in MiB) on a fleet instance to allocate for the container group.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setContainerDefinitions
(List<Object> value) The set of container definitions that are included in the container group.void
The set of container definitions that are included in the container group.void
A descriptive identifier for the container group definition.void
setOperatingSystem
(String value) The platform required for all containers in the container group definition.void
setSchedulingStrategy
(String value) The method for deploying the container group across fleet instances.void
An array of key-value pairs to apply to this resource.void
setTotalCpuLimit
(Number value) The amount of CPU units on a fleet instance to allocate for the container group.void
setTotalMemoryLimit
(Number value) The amount of memory (in MiB) on a fleet instance to allocate for the container group.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnContainerGroupDefinition
protected CfnContainerGroupDefinition(software.amazon.jsii.JsiiObjectRef objRef) -
CfnContainerGroupDefinition
protected CfnContainerGroupDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnContainerGroupDefinition
@Stability(Stable) public CfnContainerGroupDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnContainerGroupDefinitionProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrContainerGroupDefinitionArn
The Amazon Resource Name ( ARN ) that is assigned to an Amazon GameLiftContainerGroupDefinition
resource. It uniquely identifies the resource across all AWS Regions. Format isarn:aws:gamelift:<region>::containergroupdefinition/[container group definition name]
. -
getAttrCreationTime
A time stamp indicating when this data object was created.Format is a number expressed in Unix time as milliseconds (for example
"1469498468.057"
). -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getContainerDefinitions
The set of container definitions that are included in the container group. -
setContainerDefinitions
The set of container definitions that are included in the container group. -
setContainerDefinitions
The set of container definitions that are included in the container group. -
getName
A descriptive identifier for the container group definition. -
setName
A descriptive identifier for the container group definition. -
getOperatingSystem
The platform required for all containers in the container group definition. -
setOperatingSystem
The platform required for all containers in the container group definition. -
getTotalCpuLimit
The amount of CPU units on a fleet instance to allocate for the container group. -
setTotalCpuLimit
The amount of CPU units on a fleet instance to allocate for the container group. -
getTotalMemoryLimit
The amount of memory (in MiB) on a fleet instance to allocate for the container group. -
setTotalMemoryLimit
The amount of memory (in MiB) on a fleet instance to allocate for the container group. -
getSchedulingStrategy
The method for deploying the container group across fleet instances. -
setSchedulingStrategy
The method for deploying the container group across fleet instances. -
getTags
An array of key-value pairs to apply to this resource. -
setTags
An array of key-value pairs to apply to this resource.
-