Package software.amazon.awscdk.services.pcs

Interface CfnCluster.SlurmConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.SlurmConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.SlurmConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Additional options related to the Slurm scheduler.

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.*;
 SlurmConfigurationProperty slurmConfigurationProperty = SlurmConfigurationProperty.builder()
         .accounting(AccountingProperty.builder()
                 .mode("mode")
                 // the properties below are optional
                 .defaultPurgeTimeInDays(123)
                 .build())
         .authKey(AuthKeyProperty.builder()
                 .secretArn("secretArn")
                 .secretVersion("secretVersion")
                 .build())
         .cgroupCustomSettings(List.of(CgroupCustomSettingProperty.builder()
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .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()))
         .slurmdbdCustomSettings(List.of(SlurmdbdCustomSettingProperty.builder()
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .slurmRest(SlurmRestProperty.builder()
                 .mode("mode")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.SlurmConfigurationProperty.Builder	A builder for CfnCluster.SlurmConfigurationProperty
static final class	CfnCluster.SlurmConfigurationProperty.Jsii$Proxy	An implementation for CfnCluster.SlurmConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.SlurmConfigurationProperty.Builder	builder()
default Object	getAccounting()	The accounting configuration includes configurable settings for Slurm accounting.
default Object	getAuthKey()	The shared Slurm key for authentication, also known as the cluster secret .
default Object	getCgroupCustomSettings()	Additional cgroup-specific configuration that directly maps to cgroup.conf settings.
default Object	getJwtAuth()	The JWT authentication configuration for Slurm REST API access.
default Number	getScaleDownIdleTimeInSeconds()	The time (in seconds) before an idle node is scaled down.
default Object	getSlurmCustomSettings()	Additional Slurm-specific configuration that directly maps to Slurm settings.
default Object	getSlurmdbdCustomSettings()	Additional slurmdbd-specific configuration that directly maps to slurmdbd.conf settings.
default Object	getSlurmRest()	The Slurm REST API configuration for the cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccounting

@Stability(Stable)
@Nullable
default Object getAccounting()

The accounting configuration includes configurable settings for Slurm accounting.

Returns union: either IResolvable or CfnCluster.AccountingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-accounting

getAuthKey

@Stability(Stable)
@Nullable
default Object getAuthKey()

The shared Slurm key for authentication, also known as the cluster secret .

Returns union: either IResolvable or CfnCluster.AuthKeyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-authkey

getCgroupCustomSettings

@Stability(Stable)
@Nullable
default Object getCgroupCustomSettings()

Additional cgroup-specific configuration that directly maps to cgroup.conf settings.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCluster.CgroupCustomSettingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-cgroupcustomsettings

getJwtAuth

@Stability(Stable)
@Nullable
default Object getJwtAuth()

The JWT authentication configuration for Slurm REST API access.

Returns union: either IResolvable or CfnCluster.JwtAuthProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-jwtauth

getScaleDownIdleTimeInSeconds

@Stability(Stable)
@Nullable
default Number getScaleDownIdleTimeInSeconds()

The time (in seconds) before an idle node is scaled down.

Default: 600

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-scaledownidletimeinseconds

getSlurmCustomSettings

@Stability(Stable)
@Nullable
default Object getSlurmCustomSettings()

Additional Slurm-specific configuration that directly maps to Slurm settings.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCluster.SlurmCustomSettingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-slurmcustomsettings

getSlurmdbdCustomSettings

@Stability(Stable)
@Nullable
default Object getSlurmdbdCustomSettings()

Additional slurmdbd-specific configuration that directly maps to slurmdbd.conf settings.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCluster.SlurmdbdCustomSettingProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-slurmdbdcustomsettings

getSlurmRest

@Stability(Stable)
@Nullable
default Object getSlurmRest()

The Slurm REST API configuration for the cluster.

Returns union: either IResolvable or CfnCluster.SlurmRestProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.html#cfn-pcs-cluster-slurmconfiguration-slurmrest

builder

@Stability(Stable)
static CfnCluster.SlurmConfigurationProperty.Builder builder()

Returns:

a CfnCluster.SlurmConfigurationProperty.Builder of CfnCluster.SlurmConfigurationProperty