1. Packages
  2. Alicloud Provider
  3. API Docs
  4. emrv2
  5. getClusters
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

alicloud.emrv2.getClusters

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

    This data source provides the Emr Clusters of the current Alibaba Cloud user.

    NOTE: Available since v1.199.0.

    Using getClusters

    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 getClusters(args: GetClustersArgs, opts?: InvokeOptions): Promise<GetClustersResult>
    function getClustersOutput(args: GetClustersOutputArgs, opts?: InvokeOptions): Output<GetClustersResult>
    def get_clusters(cluster_name: Optional[str] = None,
                     cluster_states: Optional[Sequence[str]] = None,
                     cluster_types: Optional[Sequence[str]] = None,
                     ids: Optional[Sequence[str]] = None,
                     max_results: Optional[int] = None,
                     name_regex: Optional[str] = None,
                     next_token: Optional[str] = None,
                     output_file: Optional[str] = None,
                     payment_types: Optional[Sequence[str]] = None,
                     resource_group_id: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetClustersResult
    def get_clusters_output(cluster_name: Optional[pulumi.Input[str]] = None,
                     cluster_states: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     cluster_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     max_results: Optional[pulumi.Input[int]] = None,
                     name_regex: Optional[pulumi.Input[str]] = None,
                     next_token: Optional[pulumi.Input[str]] = None,
                     output_file: Optional[pulumi.Input[str]] = None,
                     payment_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     resource_group_id: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]
    func GetClusters(ctx *Context, args *GetClustersArgs, opts ...InvokeOption) (*GetClustersResult, error)
    func GetClustersOutput(ctx *Context, args *GetClustersOutputArgs, opts ...InvokeOption) GetClustersResultOutput

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

    public static class GetClusters 
    {
        public static Task<GetClustersResult> InvokeAsync(GetClustersArgs args, InvokeOptions? opts = null)
        public static Output<GetClustersResult> Invoke(GetClustersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:emrv2/getClusters:getClusters
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The cluster name.
    ClusterStates List<string>
    The cluster states.
    ClusterTypes List<string>
    The cluster types.
    Ids List<string>
    A list of Cluster IDs.
    MaxResults int
    The max results is used to list clusters for next page.
    NameRegex string
    A regex string to filter results by Cluster name.
    NextToken string
    The next token is used to list clusters for next page.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PaymentTypes List<string>
    The cluster payment types.
    ResourceGroupId string
    The Resource Group ID.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    ClusterName string
    The cluster name.
    ClusterStates []string
    The cluster states.
    ClusterTypes []string
    The cluster types.
    Ids []string
    A list of Cluster IDs.
    MaxResults int
    The max results is used to list clusters for next page.
    NameRegex string
    A regex string to filter results by Cluster name.
    NextToken string
    The next token is used to list clusters for next page.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PaymentTypes []string
    The cluster payment types.
    ResourceGroupId string
    The Resource Group ID.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    clusterName String
    The cluster name.
    clusterStates List<String>
    The cluster states.
    clusterTypes List<String>
    The cluster types.
    ids List<String>
    A list of Cluster IDs.
    maxResults Integer
    The max results is used to list clusters for next page.
    nameRegex String
    A regex string to filter results by Cluster name.
    nextToken String
    The next token is used to list clusters for next page.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    paymentTypes List<String>
    The cluster payment types.
    resourceGroupId String
    The Resource Group ID.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    clusterName string
    The cluster name.
    clusterStates string[]
    The cluster states.
    clusterTypes string[]
    The cluster types.
    ids string[]
    A list of Cluster IDs.
    maxResults number
    The max results is used to list clusters for next page.
    nameRegex string
    A regex string to filter results by Cluster name.
    nextToken string
    The next token is used to list clusters for next page.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    paymentTypes string[]
    The cluster payment types.
    resourceGroupId string
    The Resource Group ID.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    cluster_name str
    The cluster name.
    cluster_states Sequence[str]
    The cluster states.
    cluster_types Sequence[str]
    The cluster types.
    ids Sequence[str]
    A list of Cluster IDs.
    max_results int
    The max results is used to list clusters for next page.
    name_regex str
    A regex string to filter results by Cluster name.
    next_token str
    The next token is used to list clusters for next page.
    output_file str
    File name where to save data source results (after running pulumi preview).
    payment_types Sequence[str]
    The cluster payment types.
    resource_group_id str
    The Resource Group ID.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    clusterName String
    The cluster name.
    clusterStates List<String>
    The cluster states.
    clusterTypes List<String>
    The cluster types.
    ids List<String>
    A list of Cluster IDs.
    maxResults Number
    The max results is used to list clusters for next page.
    nameRegex String
    A regex string to filter results by Cluster name.
    nextToken String
    The next token is used to list clusters for next page.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    paymentTypes List<String>
    The cluster payment types.
    resourceGroupId String
    The Resource Group ID.
    tags Map<String>
    A mapping of tags to assign to the resource.

    getClusters Result

    The following output properties are available:

    Clusters List<Pulumi.AliCloud.Emrv2.Outputs.GetClustersCluster>
    A list of Emr Clusters. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    A list of Cluster IDS.
    Names List<string>
    A list of Cluster names.
    TotalCount int
    The total count of list clusters.
    ClusterName string
    The name of the emr cluster.
    ClusterStates List<string>
    ClusterTypes List<string>
    MaxResults int
    NameRegex string
    NextToken string
    OutputFile string
    PaymentTypes List<string>
    ResourceGroupId string
    The resource group id of the resource.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Clusters []GetClustersCluster
    A list of Emr Clusters. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A list of Cluster IDS.
    Names []string
    A list of Cluster names.
    TotalCount int
    The total count of list clusters.
    ClusterName string
    The name of the emr cluster.
    ClusterStates []string
    ClusterTypes []string
    MaxResults int
    NameRegex string
    NextToken string
    OutputFile string
    PaymentTypes []string
    ResourceGroupId string
    The resource group id of the resource.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    clusters List<GetClustersCluster>
    A list of Emr Clusters. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Cluster IDS.
    names List<String>
    A list of Cluster names.
    totalCount Integer
    The total count of list clusters.
    clusterName String
    The name of the emr cluster.
    clusterStates List<String>
    clusterTypes List<String>
    maxResults Integer
    nameRegex String
    nextToken String
    outputFile String
    paymentTypes List<String>
    resourceGroupId String
    The resource group id of the resource.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    clusters GetClustersCluster[]
    A list of Emr Clusters. Each element contains the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A list of Cluster IDS.
    names string[]
    A list of Cluster names.
    totalCount number
    The total count of list clusters.
    clusterName string
    The name of the emr cluster.
    clusterStates string[]
    clusterTypes string[]
    maxResults number
    nameRegex string
    nextToken string
    outputFile string
    paymentTypes string[]
    resourceGroupId string
    The resource group id of the resource.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    clusters Sequence[GetClustersCluster]
    A list of Emr Clusters. Each element contains the following attributes:
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A list of Cluster IDS.
    names Sequence[str]
    A list of Cluster names.
    total_count int
    The total count of list clusters.
    cluster_name str
    The name of the emr cluster.
    cluster_states Sequence[str]
    cluster_types Sequence[str]
    max_results int
    name_regex str
    next_token str
    output_file str
    payment_types Sequence[str]
    resource_group_id str
    The resource group id of the resource.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    clusters List<Property Map>
    A list of Emr Clusters. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of Cluster IDS.
    names List<String>
    A list of Cluster names.
    totalCount Number
    The total count of list clusters.
    clusterName String
    The name of the emr cluster.
    clusterStates List<String>
    clusterTypes List<String>
    maxResults Number
    nameRegex String
    nextToken String
    outputFile String
    paymentTypes List<String>
    resourceGroupId String
    The resource group id of the resource.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Supporting Types

    GetClustersCluster

    ClusterId string
    The first ID of the resource.
    ClusterName string
    The cluster name.
    ClusterState string
    The state of the emr cluster.
    ClusterType string
    The type of the emr cluster.
    CreateTime string
    The creation time of the resource.
    EmrDefaultRole string
    The ecs default role belongs to this emr cluster.
    EndTime string
    The end time of the resource.
    ExpireTime string
    The expire time of the resource.
    PaymentType string
    The payment type of the emr cluster.
    ReadyTime string
    The ready time of the resource.
    ReleaseVersion string
    The release version of the resource.
    ResourceGroupId string
    The Resource Group ID.
    StateChangeReason Dictionary<string, string>
    The cluster state change reason.
    Tags List<Pulumi.AliCloud.Emrv2.Inputs.GetClustersClusterTag>
    A mapping of tags to assign to the resource.
    ClusterId string
    The first ID of the resource.
    ClusterName string
    The cluster name.
    ClusterState string
    The state of the emr cluster.
    ClusterType string
    The type of the emr cluster.
    CreateTime string
    The creation time of the resource.
    EmrDefaultRole string
    The ecs default role belongs to this emr cluster.
    EndTime string
    The end time of the resource.
    ExpireTime string
    The expire time of the resource.
    PaymentType string
    The payment type of the emr cluster.
    ReadyTime string
    The ready time of the resource.
    ReleaseVersion string
    The release version of the resource.
    ResourceGroupId string
    The Resource Group ID.
    StateChangeReason map[string]string
    The cluster state change reason.
    Tags []GetClustersClusterTag
    A mapping of tags to assign to the resource.
    clusterId String
    The first ID of the resource.
    clusterName String
    The cluster name.
    clusterState String
    The state of the emr cluster.
    clusterType String
    The type of the emr cluster.
    createTime String
    The creation time of the resource.
    emrDefaultRole String
    The ecs default role belongs to this emr cluster.
    endTime String
    The end time of the resource.
    expireTime String
    The expire time of the resource.
    paymentType String
    The payment type of the emr cluster.
    readyTime String
    The ready time of the resource.
    releaseVersion String
    The release version of the resource.
    resourceGroupId String
    The Resource Group ID.
    stateChangeReason Map<String,String>
    The cluster state change reason.
    tags List<GetClustersClusterTag>
    A mapping of tags to assign to the resource.
    clusterId string
    The first ID of the resource.
    clusterName string
    The cluster name.
    clusterState string
    The state of the emr cluster.
    clusterType string
    The type of the emr cluster.
    createTime string
    The creation time of the resource.
    emrDefaultRole string
    The ecs default role belongs to this emr cluster.
    endTime string
    The end time of the resource.
    expireTime string
    The expire time of the resource.
    paymentType string
    The payment type of the emr cluster.
    readyTime string
    The ready time of the resource.
    releaseVersion string
    The release version of the resource.
    resourceGroupId string
    The Resource Group ID.
    stateChangeReason {[key: string]: string}
    The cluster state change reason.
    tags GetClustersClusterTag[]
    A mapping of tags to assign to the resource.
    cluster_id str
    The first ID of the resource.
    cluster_name str
    The cluster name.
    cluster_state str
    The state of the emr cluster.
    cluster_type str
    The type of the emr cluster.
    create_time str
    The creation time of the resource.
    emr_default_role str
    The ecs default role belongs to this emr cluster.
    end_time str
    The end time of the resource.
    expire_time str
    The expire time of the resource.
    payment_type str
    The payment type of the emr cluster.
    ready_time str
    The ready time of the resource.
    release_version str
    The release version of the resource.
    resource_group_id str
    The Resource Group ID.
    state_change_reason Mapping[str, str]
    The cluster state change reason.
    tags Sequence[GetClustersClusterTag]
    A mapping of tags to assign to the resource.
    clusterId String
    The first ID of the resource.
    clusterName String
    The cluster name.
    clusterState String
    The state of the emr cluster.
    clusterType String
    The type of the emr cluster.
    createTime String
    The creation time of the resource.
    emrDefaultRole String
    The ecs default role belongs to this emr cluster.
    endTime String
    The end time of the resource.
    expireTime String
    The expire time of the resource.
    paymentType String
    The payment type of the emr cluster.
    readyTime String
    The ready time of the resource.
    releaseVersion String
    The release version of the resource.
    resourceGroupId String
    The Resource Group ID.
    stateChangeReason Map<String>
    The cluster state change reason.
    tags List<Property Map>
    A mapping of tags to assign to the resource.

    GetClustersClusterTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi