Package software.amazon.awscdk.cfnpropertymixins.services.pcs

Class CfnClusterPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.pcs.CfnClusterPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.210Z")
@Stability(Stable)
public class CfnClusterPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates an AWS PCS cluster resource.

For more information, see Creating a cluster in Parallel Computing Service in the AWS PCS User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.pcs.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnClusterPropsMixin cfnClusterPropsMixin = CfnClusterPropsMixin.Builder.create(CfnClusterMixinProps.builder()
         .name("name")
         .networking(NetworkingProperty.builder()
                 .networkType("networkType")
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .scheduler(SchedulerProperty.builder()
                 .type("type")
                 .version("version")
                 .build())
         .size("size")
         .slurmConfiguration(SlurmConfigurationProperty.builder()
                 .accounting(AccountingProperty.builder()
                         .defaultPurgeTimeInDays(123)
                         .mode("mode")
                         .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnClusterPropsMixin.AccountingProperty	The accounting configuration includes configurable settings for Slurm accounting.
static interface	CfnClusterPropsMixin.AuthKeyProperty	The shared Slurm key for authentication, also known as the cluster secret .
static final class	CfnClusterPropsMixin.Builder	A fluent builder for CfnClusterPropsMixin.
static interface	CfnClusterPropsMixin.EndpointProperty	An endpoint available for interaction with the scheduler.
static interface	CfnClusterPropsMixin.ErrorInfoProperty	An error that occurred during resource creation.
static interface	CfnClusterPropsMixin.JwtAuthProperty	The JWT authentication configuration for Slurm REST API access.
static interface	CfnClusterPropsMixin.JwtKeyProperty	The JWT key stored in AWS Secrets Manager for Slurm REST API authentication.
static interface	CfnClusterPropsMixin.NetworkingProperty	The networking configuration for the cluster's control plane.
static interface	CfnClusterPropsMixin.SchedulerProperty	The cluster management and job scheduling software associated with the cluster.
static interface	CfnClusterPropsMixin.SlurmConfigurationProperty	Additional options related to the Slurm scheduler.
static interface	CfnClusterPropsMixin.SlurmCustomSettingProperty	Additional settings that directly map to Slurm settings.
static interface	CfnClusterPropsMixin.SlurmRestProperty	The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnClusterPropsMixin(CfnClusterMixinProps props)	Create a mixin to apply properties to AWS::PCS::Cluster.
	CfnClusterPropsMixin(CfnClusterMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::PCS::Cluster.
protected	CfnClusterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClusterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnClusterMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnClusterPropsMixin

protected CfnClusterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnClusterPropsMixin

protected CfnClusterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnClusterPropsMixin

@Stability(Stable)
public CfnClusterPropsMixin(@NotNull
 CfnClusterMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::PCS::Cluster.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnClusterPropsMixin

@Stability(Stable)
public CfnClusterPropsMixin(@NotNull
 CfnClusterMixinProps props)

Create a mixin to apply properties to AWS::PCS::Cluster.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnClusterMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()