Package software.amazon.awscdk.services.pcs

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:17.051Z")
@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()
                 .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()
                 .authKey(AuthKeyProperty.builder()
                         .secretArn("secretArn")
                         .secretVersion("secretVersion")
                         .build())
                 .scaleDownIdleTimeInSeconds(123)
                 .slurmCustomSettings(List.of(SlurmCustomSettingProperty.builder()
                         .parameterName("parameterName")
                         .parameterValue("parameterValue")
                         .build()))
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnClusterProps.Builder	builder()
default String	getName()	The name that identifies the cluster.
Object	getNetworking()	The networking configuration for the cluster's control plane.
Object	getScheduler()	The cluster management and job scheduling software associated with the cluster.
String	getSize()	The size of the cluster.
default Object	getSlurmConfiguration()	Additional options related to the Slurm scheduler.
default Map<String,String>	getTags()	1 or more tags added to the resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNetworking

@Stability(Stable)
@NotNull
Object getNetworking()

The networking configuration for the cluster's control plane.

See Also:

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

getScheduler

@Stability(Stable)
@NotNull
Object getScheduler()

The cluster management and job scheduling software associated with the cluster.

See Also:

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

getSize

@Stability(Stable)
@NotNull
String getSize()

The size of the cluster.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name that identifies the cluster.

See Also:

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

getSlurmConfiguration

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

Additional options related to the Slurm scheduler.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> 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:

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

builder

@Stability(Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps