Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. pcs
  5. Cluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.pcs.Cluster

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    AWS::PCS::Cluster resource creates an AWS PCS cluster.

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            networking: Optional[NetworkingPropertiesArgs] = None,
            scheduler: Optional[SchedulerPropertiesArgs] = None,
            size: Optional[ClusterSize] = None,
            name: Optional[str] = None,
            slurm_configuration: Optional[SlurmConfigurationPropertiesArgs] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: aws-native:pcs:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Cluster resource accepts the following input properties:

    Networking Pulumi.AwsNative.Pcs.Inputs.NetworkingProperties
    The networking configuration for the cluster's control plane.
    Scheduler Pulumi.AwsNative.Pcs.Inputs.SchedulerProperties
    The cluster management and job scheduling software associated with the cluster.
    Size Pulumi.AwsNative.Pcs.ClusterSize
    The size of the cluster.
    Name string
    The name that identifies the cluster.
    SlurmConfiguration Pulumi.AwsNative.Pcs.Inputs.SlurmConfigurationProperties
    Additional options related to the Slurm scheduler.
    Tags Dictionary<string, string>
    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.
    Networking NetworkingPropertiesArgs
    The networking configuration for the cluster's control plane.
    Scheduler SchedulerPropertiesArgs
    The cluster management and job scheduling software associated with the cluster.
    Size ClusterSize
    The size of the cluster.
    Name string
    The name that identifies the cluster.
    SlurmConfiguration SlurmConfigurationPropertiesArgs
    Additional options related to the Slurm scheduler.
    Tags map[string]string
    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.
    networking NetworkingProperties
    The networking configuration for the cluster's control plane.
    scheduler SchedulerProperties
    The cluster management and job scheduling software associated with the cluster.
    size ClusterSize
    The size of the cluster.
    name String
    The name that identifies the cluster.
    slurmConfiguration SlurmConfigurationProperties
    Additional options related to the Slurm scheduler.
    tags Map<String,String>
    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.
    networking NetworkingProperties
    The networking configuration for the cluster's control plane.
    scheduler SchedulerProperties
    The cluster management and job scheduling software associated with the cluster.
    size ClusterSize
    The size of the cluster.
    name string
    The name that identifies the cluster.
    slurmConfiguration SlurmConfigurationProperties
    Additional options related to the Slurm scheduler.
    tags {[key: string]: string}
    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.
    networking NetworkingPropertiesArgs
    The networking configuration for the cluster's control plane.
    scheduler SchedulerPropertiesArgs
    The cluster management and job scheduling software associated with the cluster.
    size ClusterSize
    The size of the cluster.
    name str
    The name that identifies the cluster.
    slurm_configuration SlurmConfigurationPropertiesArgs
    Additional options related to the Slurm scheduler.
    tags Mapping[str, str]
    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.
    networking Property Map
    The networking configuration for the cluster's control plane.
    scheduler Property Map
    The cluster management and job scheduling software associated with the cluster.
    size "SMALL" | "MEDIUM" | "LARGE"
    The size of the cluster.
    name String
    The name that identifies the cluster.
    slurmConfiguration Property Map
    Additional options related to the Slurm scheduler.
    tags Map<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Arn string
    The unique Amazon Resource Name (ARN) of the cluster.
    AwsId string
    The generated unique ID of the cluster.
    Endpoints List<Pulumi.AwsNative.Pcs.Outputs.ClusterEndpoint>
    The list of endpoints available for interaction with the scheduler.
    ErrorInfo List<Pulumi.AwsNative.Pcs.Outputs.ClusterErrorInfo>
    The list of errors that occurred during cluster provisioning.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.Pcs.ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    Arn string
    The unique Amazon Resource Name (ARN) of the cluster.
    AwsId string
    The generated unique ID of the cluster.
    Endpoints []ClusterEndpoint
    The list of endpoints available for interaction with the scheduler.
    ErrorInfo []ClusterErrorInfo
    The list of errors that occurred during cluster provisioning.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    arn String
    The unique Amazon Resource Name (ARN) of the cluster.
    awsId String
    The generated unique ID of the cluster.
    endpoints List<ClusterEndpoint>
    The list of endpoints available for interaction with the scheduler.
    errorInfo List<ClusterErrorInfo>
    The list of errors that occurred during cluster provisioning.
    id String
    The provider-assigned unique ID for this managed resource.
    status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    arn string
    The unique Amazon Resource Name (ARN) of the cluster.
    awsId string
    The generated unique ID of the cluster.
    endpoints ClusterEndpoint[]
    The list of endpoints available for interaction with the scheduler.
    errorInfo ClusterErrorInfo[]
    The list of errors that occurred during cluster provisioning.
    id string
    The provider-assigned unique ID for this managed resource.
    status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    arn str
    The unique Amazon Resource Name (ARN) of the cluster.
    aws_id str
    The generated unique ID of the cluster.
    endpoints Sequence[ClusterEndpoint]
    The list of endpoints available for interaction with the scheduler.
    error_info Sequence[ClusterErrorInfo]
    The list of errors that occurred during cluster provisioning.
    id str
    The provider-assigned unique ID for this managed resource.
    status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    arn String
    The unique Amazon Resource Name (ARN) of the cluster.
    awsId String
    The generated unique ID of the cluster.
    endpoints List<Property Map>
    The list of endpoints available for interaction with the scheduler.
    errorInfo List<Property Map>
    The list of errors that occurred during cluster provisioning.
    id String
    The provider-assigned unique ID for this managed resource.
    status "CREATING" | "ACTIVE" | "UPDATING" | "DELETING" | "CREATE_FAILED" | "DELETE_FAILED" | "UPDATE_FAILED"
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.

    Supporting Types

    ClusterEndpoint, ClusterEndpointArgs

    Port string
    The endpoint's connection port number.
    PrivateIpAddress string
    The endpoint's private IP address.
    Type Pulumi.AwsNative.Pcs.ClusterEndpointType
    Indicates the type of endpoint running at the specific IP address.
    PublicIpAddress string
    The endpoint's public IP address.
    Port string
    The endpoint's connection port number.
    PrivateIpAddress string
    The endpoint's private IP address.
    Type ClusterEndpointType
    Indicates the type of endpoint running at the specific IP address.
    PublicIpAddress string
    The endpoint's public IP address.
    port String
    The endpoint's connection port number.
    privateIpAddress String
    The endpoint's private IP address.
    type ClusterEndpointType
    Indicates the type of endpoint running at the specific IP address.
    publicIpAddress String
    The endpoint's public IP address.
    port string
    The endpoint's connection port number.
    privateIpAddress string
    The endpoint's private IP address.
    type ClusterEndpointType
    Indicates the type of endpoint running at the specific IP address.
    publicIpAddress string
    The endpoint's public IP address.
    port str
    The endpoint's connection port number.
    private_ip_address str
    The endpoint's private IP address.
    type ClusterEndpointType
    Indicates the type of endpoint running at the specific IP address.
    public_ip_address str
    The endpoint's public IP address.
    port String
    The endpoint's connection port number.
    privateIpAddress String
    The endpoint's private IP address.
    type "SLURMCTLD" | "SLURMDBD"
    Indicates the type of endpoint running at the specific IP address.
    publicIpAddress String
    The endpoint's public IP address.

    ClusterEndpointType, ClusterEndpointTypeArgs

    Slurmctld
    SLURMCTLD
    Slurmdbd
    SLURMDBD
    ClusterEndpointTypeSlurmctld
    SLURMCTLD
    ClusterEndpointTypeSlurmdbd
    SLURMDBD
    Slurmctld
    SLURMCTLD
    Slurmdbd
    SLURMDBD
    Slurmctld
    SLURMCTLD
    Slurmdbd
    SLURMDBD
    SLURMCTLD
    SLURMCTLD
    SLURMDBD
    SLURMDBD
    "SLURMCTLD"
    SLURMCTLD
    "SLURMDBD"
    SLURMDBD

    ClusterErrorInfo, ClusterErrorInfoArgs

    Code string
    The short-form error code.
    Message string
    The detailed error information.
    Code string
    The short-form error code.
    Message string
    The detailed error information.
    code String
    The short-form error code.
    message String
    The detailed error information.
    code string
    The short-form error code.
    message string
    The detailed error information.
    code str
    The short-form error code.
    message str
    The detailed error information.
    code String
    The short-form error code.
    message String
    The detailed error information.

    ClusterSchedulerPropertiesType, ClusterSchedulerPropertiesTypeArgs

    Slurm
    SLURM
    ClusterSchedulerPropertiesTypeSlurm
    SLURM
    Slurm
    SLURM
    Slurm
    SLURM
    SLURM
    SLURM
    "SLURM"
    SLURM

    ClusterSize, ClusterSizeArgs

    Small
    SMALL
    Medium
    MEDIUM
    Large
    LARGE
    ClusterSizeSmall
    SMALL
    ClusterSizeMedium
    MEDIUM
    ClusterSizeLarge
    LARGE
    Small
    SMALL
    Medium
    MEDIUM
    Large
    LARGE
    Small
    SMALL
    Medium
    MEDIUM
    Large
    LARGE
    SMALL
    SMALL
    MEDIUM
    MEDIUM
    LARGE
    LARGE
    "SMALL"
    SMALL
    "MEDIUM"
    MEDIUM
    "LARGE"
    LARGE

    ClusterStatus, ClusterStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleting
    DELETING
    CreateFailed
    CREATE_FAILED
    DeleteFailed
    DELETE_FAILED
    UpdateFailed
    UPDATE_FAILED
    ClusterStatusCreating
    CREATING
    ClusterStatusActive
    ACTIVE
    ClusterStatusUpdating
    UPDATING
    ClusterStatusDeleting
    DELETING
    ClusterStatusCreateFailed
    CREATE_FAILED
    ClusterStatusDeleteFailed
    DELETE_FAILED
    ClusterStatusUpdateFailed
    UPDATE_FAILED
    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleting
    DELETING
    CreateFailed
    CREATE_FAILED
    DeleteFailed
    DELETE_FAILED
    UpdateFailed
    UPDATE_FAILED
    Creating
    CREATING
    Active
    ACTIVE
    Updating
    UPDATING
    Deleting
    DELETING
    CreateFailed
    CREATE_FAILED
    DeleteFailed
    DELETE_FAILED
    UpdateFailed
    UPDATE_FAILED
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    UPDATING
    UPDATING
    DELETING
    DELETING
    CREATE_FAILED
    CREATE_FAILED
    DELETE_FAILED
    DELETE_FAILED
    UPDATE_FAILED
    UPDATE_FAILED
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "UPDATING"
    UPDATING
    "DELETING"
    DELETING
    "CREATE_FAILED"
    CREATE_FAILED
    "DELETE_FAILED"
    DELETE_FAILED
    "UPDATE_FAILED"
    UPDATE_FAILED

    ComputeNodeGroupSlurmCustomSetting, ComputeNodeGroupSlurmCustomSettingArgs

    ParameterName string
    AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
    ParameterValue string
    The value for the configured Slurm setting.
    ParameterName string
    AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
    ParameterValue string
    The value for the configured Slurm setting.
    parameterName String
    AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
    parameterValue String
    The value for the configured Slurm setting.
    parameterName string
    AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
    parameterValue string
    The value for the configured Slurm setting.
    parameter_name str
    AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
    parameter_value str
    The value for the configured Slurm setting.
    parameterName String
    AWS PCS supports configuration of the following Slurm parameters for compute node groups: Weight and RealMemory.
    parameterValue String
    The value for the configured Slurm setting.

    NetworkingProperties, NetworkingPropertiesArgs

    SecurityGroupIds List<string>
    The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
    SubnetIds List<string>
    The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list.
    SecurityGroupIds []string
    The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
    SubnetIds []string
    The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list.
    securityGroupIds List<String>
    The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
    subnetIds List<String>
    The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list.
    securityGroupIds string[]
    The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
    subnetIds string[]
    The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list.
    security_group_ids Sequence[str]
    The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
    subnet_ids Sequence[str]
    The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list.
    securityGroupIds List<String>
    The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.
    subnetIds List<String>
    The list of subnet IDs where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts, AWS Wavelength, or an AWS Local Zone. AWS PCS currently supports only 1 subnet in this list.

    SchedulerProperties, SchedulerPropertiesArgs

    Type Pulumi.AwsNative.Pcs.ClusterSchedulerPropertiesType
    The software AWS PCS uses to manage cluster scaling and job scheduling.
    Version string
    The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling.
    Type ClusterSchedulerPropertiesType
    The software AWS PCS uses to manage cluster scaling and job scheduling.
    Version string
    The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling.
    type ClusterSchedulerPropertiesType
    The software AWS PCS uses to manage cluster scaling and job scheduling.
    version String
    The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling.
    type ClusterSchedulerPropertiesType
    The software AWS PCS uses to manage cluster scaling and job scheduling.
    version string
    The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling.
    type ClusterSchedulerPropertiesType
    The software AWS PCS uses to manage cluster scaling and job scheduling.
    version str
    The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling.
    type "SLURM"
    The software AWS PCS uses to manage cluster scaling and job scheduling.
    version String
    The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling.

    SlurmConfigurationProperties, SlurmConfigurationPropertiesArgs

    SlurmCustomSettings List<Pulumi.AwsNative.Pcs.Inputs.ComputeNodeGroupSlurmCustomSetting>
    Additional Slurm-specific configuration that directly maps to Slurm settings.
    SlurmCustomSettings []ComputeNodeGroupSlurmCustomSetting
    Additional Slurm-specific configuration that directly maps to Slurm settings.
    slurmCustomSettings List<ComputeNodeGroupSlurmCustomSetting>
    Additional Slurm-specific configuration that directly maps to Slurm settings.
    slurmCustomSettings ComputeNodeGroupSlurmCustomSetting[]
    Additional Slurm-specific configuration that directly maps to Slurm settings.
    slurm_custom_settings Sequence[ComputeNodeGroupSlurmCustomSetting]
    Additional Slurm-specific configuration that directly maps to Slurm settings.
    slurmCustomSettings List<Property Map>
    Additional Slurm-specific configuration that directly maps to Slurm settings.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
    pulumi/pulumi-aws-native