Interface CfnClusterProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
date="2025-12-05T22:26:41.251Z")
@Stability(Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnCluster.
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.pcs.*;
CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
.networking(NetworkingProperty.builder()
.networkType("networkType")
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.scheduler(SchedulerProperty.builder()
.type("type")
.version("version")
.build())
.size("size")
// the properties below are optional
.name("name")
.slurmConfiguration(SlurmConfigurationProperty.builder()
.accounting(AccountingProperty.builder()
.mode("mode")
// the properties below are optional
.defaultPurgeTimeInDays(123)
.build())
.authKey(AuthKeyProperty.builder()
.secretArn("secretArn")
.secretVersion("secretVersion")
.build())
.jwtAuth(JwtAuthProperty.builder()
.jwtKey(JwtKeyProperty.builder()
.secretArn("secretArn")
.secretVersion("secretVersion")
.build())
.build())
.scaleDownIdleTimeInSeconds(123)
.slurmCustomSettings(List.of(SlurmCustomSettingProperty.builder()
.parameterName("parameterName")
.parameterValue("parameterValue")
.build()))
.slurmRest(SlurmRestProperty.builder()
.mode("mode")
.build())
.build())
.tags(Map.of(
"tagsKey", "tags"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnClusterPropsstatic final classAn implementation forCfnClusterProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnClusterProps.Builderbuilder()default StringgetName()The name that identifies the cluster.The networking configuration for the cluster's control plane.The cluster management and job scheduling software associated with the cluster.getSize()The size of the cluster.default ObjectAdditional options related to the Slurm scheduler.getTags()1 or more tags added to the resource.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNetworking
The networking configuration for the cluster's control plane.Returns union: either
IResolvableorCfnCluster.NetworkingProperty- See Also:
-
getScheduler
The cluster management and job scheduling software associated with the cluster.Returns union: either
IResolvableorCfnCluster.SchedulerProperty- See Also:
-
getSize
The size of the cluster.SMALL: 32 compute nodes and 256 jobsMEDIUM: 512 compute nodes and 8192 jobsLARGE: 2048 compute nodes and 16,384 jobs
- See Also:
-
getName
The name that identifies the cluster.- See Also:
-
getSlurmConfiguration
Additional options related to the Slurm scheduler.Returns union: either
IResolvableorCfnCluster.SlurmConfigurationProperty- See Also:
-
getTags
1 or more tags added to the resource.Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
- See Also:
-
builder
- Returns:
- a
CfnClusterProps.BuilderofCfnClusterProps
-