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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.pcs.getCluster

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

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

    Using getCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(arn: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster in the Go SDK.

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:pcs:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The unique Amazon Resource Name (ARN) of the cluster.
    Arn string
    The unique Amazon Resource Name (ARN) of the cluster.
    arn String
    The unique Amazon Resource Name (ARN) of the cluster.
    arn string
    The unique Amazon Resource Name (ARN) of the cluster.
    arn str
    The unique Amazon Resource Name (ARN) of the cluster.
    arn String
    The unique Amazon Resource Name (ARN) of the cluster.

    getCluster Result

    The following output properties are available:

    Arn string
    The unique Amazon Resource Name (ARN) 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 generated unique ID of the cluster.
    Status Pulumi.AwsNative.Pcs.ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    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.
    Arn string
    The unique Amazon Resource Name (ARN) 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 generated unique ID of the cluster.
    Status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    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.
    arn String
    The unique Amazon Resource Name (ARN) 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 generated unique ID of the cluster.
    status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    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.
    arn string
    The unique Amazon Resource Name (ARN) 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 generated unique ID of the cluster.
    status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    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.
    arn str
    The unique Amazon Resource Name (ARN) 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 generated unique ID of the cluster.
    status ClusterStatus
    The provisioning status of the cluster. The provisioning status doesn't indicate the overall health of the cluster.
    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.
    arn String
    The unique Amazon Resource Name (ARN) 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 generated unique ID of the cluster.
    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.
    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.

    Supporting Types

    ClusterEndpoint

    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

    ClusterErrorInfo

    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.

    ClusterStatus

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native