Package software.amazon.awscdk.services.pcs

Class CfnCluster

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.pcs.CfnCluster
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.110.0 (build 336b265)", date="2025-04-22T23:08:17.048Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable, ITaggableV2
The AWS::PCS::Cluster resource creates an AWS PCS cluster.

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.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCluster

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

    • CfnCluster

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

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterProps 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

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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 class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The unique Amazon Resource Name (ARN) of the cluster.

    • getAttrEndpoints

      @Stability(Stable) @NotNull public IResolvable getAttrEndpoints()
      The list of endpoints available for interaction with the scheduler.

    • getAttrErrorInfo

      @Stability(Stable) @NotNull public IResolvable getAttrErrorInfo()
      The list of errors that occurred during cluster provisioning.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The generated unique ID of the cluster.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The provisioning status of the cluster.

      The provisioning status doesn't indicate the overall health of the cluster.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getNetworking

      @Stability(Stable) @NotNull public Object getNetworking()
      The networking configuration for the cluster's control plane.

    • setNetworking

      @Stability(Stable) public void setNetworking(@NotNull IResolvable value)
      The networking configuration for the cluster's control plane.

    • setNetworking

      @Stability(Stable) public void setNetworking(@NotNull CfnCluster.NetworkingProperty value)
      The networking configuration for the cluster's control plane.

    • getScheduler

      @Stability(Stable) @NotNull public Object getScheduler()
      The cluster management and job scheduling software associated with the cluster.

    • setScheduler

      @Stability(Stable) public void setScheduler(@NotNull IResolvable value)
      The cluster management and job scheduling software associated with the cluster.

    • setScheduler

      @Stability(Stable) public void setScheduler(@NotNull CfnCluster.SchedulerProperty value)
      The cluster management and job scheduling software associated with the cluster.

    • getSize

      @Stability(Stable) @NotNull public String getSize()
      The size of the cluster.

    • setSize

      @Stability(Stable) public void setSize(@NotNull String value)
      The size of the cluster.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name that identifies the cluster.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name that identifies the cluster.

    • getSlurmConfiguration

      @Stability(Stable) @Nullable public Object getSlurmConfiguration()
      Additional options related to the Slurm scheduler.

    • setSlurmConfiguration

      @Stability(Stable) public void setSlurmConfiguration(@Nullable IResolvable value)
      Additional options related to the Slurm scheduler.

    • setSlurmConfiguration

      @Stability(Stable) public void setSlurmConfiguration(@Nullable CfnCluster.SlurmConfigurationProperty value)
      Additional options related to the Slurm scheduler.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      1 or more tags added to the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      1 or more tags added to the resource.