1. Packages
  2. Rancher2
  3. API Docs
  4. getMultiClusterApp
Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi

rancher2.getMultiClusterApp

Explore with Pulumi AI

rancher2 logo
Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi

    Use this data source to retrieve information about a Rancher v2 multi cluster app.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const foo = rancher2.getMultiClusterApp({
        name: "foo",
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    foo = rancher2.get_multi_cluster_app(name="foo")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v6/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rancher2.LookupMultiClusterApp(ctx, &rancher2.LookupMultiClusterAppArgs{
    			Name: "foo",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Rancher2.GetMultiClusterApp.Invoke(new()
        {
            Name = "foo",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.Rancher2Functions;
    import com.pulumi.rancher2.inputs.GetMultiClusterAppArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var foo = Rancher2Functions.getMultiClusterApp(GetMultiClusterAppArgs.builder()
                .name("foo")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: rancher2:getMultiClusterApp
          Arguments:
            name: foo
    

    Using getMultiClusterApp

    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 getMultiClusterApp(args: GetMultiClusterAppArgs, opts?: InvokeOptions): Promise<GetMultiClusterAppResult>
    function getMultiClusterAppOutput(args: GetMultiClusterAppOutputArgs, opts?: InvokeOptions): Output<GetMultiClusterAppResult>
    def get_multi_cluster_app(name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetMultiClusterAppResult
    def get_multi_cluster_app_output(name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetMultiClusterAppResult]
    func LookupMultiClusterApp(ctx *Context, args *LookupMultiClusterAppArgs, opts ...InvokeOption) (*LookupMultiClusterAppResult, error)
    func LookupMultiClusterAppOutput(ctx *Context, args *LookupMultiClusterAppOutputArgs, opts ...InvokeOption) LookupMultiClusterAppResultOutput

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

    public static class GetMultiClusterApp 
    {
        public static Task<GetMultiClusterAppResult> InvokeAsync(GetMultiClusterAppArgs args, InvokeOptions? opts = null)
        public static Output<GetMultiClusterAppResult> Invoke(GetMultiClusterAppInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMultiClusterAppResult> getMultiClusterApp(GetMultiClusterAppArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: rancher2:index/getMultiClusterApp:getMultiClusterApp
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The multi cluster app name (string)
    Name string
    The multi cluster app name (string)
    name String
    The multi cluster app name (string)
    name string
    The multi cluster app name (string)
    name str
    The multi cluster app name (string)
    name String
    The multi cluster app name (string)

    getMultiClusterApp Result

    The following output properties are available:

    Annotations Dictionary<string, object>
    (Computed) Annotations for multi cluster app object (map)
    Answers List<GetMultiClusterAppAnswer>
    (Computed) The multi cluster app answers (list)
    CatalogName string
    (Computed) The multi cluster app catalog name (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, object>
    (Computed) Labels for multi cluster app object (map)
    Members List<GetMultiClusterAppMember>
    (Computed) The multi cluster app members (list)
    Name string
    RevisionHistoryLimit int
    (Computed) The multi cluster app revision history limit (int)
    RevisionId string
    (Computed) Current revision id for the multi cluster app (string)
    Roles List<string>
    (Computed) The multi cluster app roles (list)
    Targets List<GetMultiClusterAppTarget>
    (Computed) The multi cluster app target projects (list)
    TemplateName string
    (Computed) The multi cluster app template name (string)
    TemplateVersion string
    (Computed) The multi cluster app template version (string)
    TemplateVersionId string
    (Computed) The multi cluster app template version ID (string)
    UpgradeStrategies List<GetMultiClusterAppUpgradeStrategy>
    (Computed) The multi cluster app upgrade strategy (list)
    Annotations map[string]interface{}
    (Computed) Annotations for multi cluster app object (map)
    Answers []GetMultiClusterAppAnswer
    (Computed) The multi cluster app answers (list)
    CatalogName string
    (Computed) The multi cluster app catalog name (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]interface{}
    (Computed) Labels for multi cluster app object (map)
    Members []GetMultiClusterAppMember
    (Computed) The multi cluster app members (list)
    Name string
    RevisionHistoryLimit int
    (Computed) The multi cluster app revision history limit (int)
    RevisionId string
    (Computed) Current revision id for the multi cluster app (string)
    Roles []string
    (Computed) The multi cluster app roles (list)
    Targets []GetMultiClusterAppTarget
    (Computed) The multi cluster app target projects (list)
    TemplateName string
    (Computed) The multi cluster app template name (string)
    TemplateVersion string
    (Computed) The multi cluster app template version (string)
    TemplateVersionId string
    (Computed) The multi cluster app template version ID (string)
    UpgradeStrategies []GetMultiClusterAppUpgradeStrategy
    (Computed) The multi cluster app upgrade strategy (list)
    annotations Map<String,Object>
    (Computed) Annotations for multi cluster app object (map)
    answers List<GetMultiClusterAppAnswer>
    (Computed) The multi cluster app answers (list)
    catalogName String
    (Computed) The multi cluster app catalog name (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,Object>
    (Computed) Labels for multi cluster app object (map)
    members List<GetMultiClusterAppMember>
    (Computed) The multi cluster app members (list)
    name String
    revisionHistoryLimit Integer
    (Computed) The multi cluster app revision history limit (int)
    revisionId String
    (Computed) Current revision id for the multi cluster app (string)
    roles List<String>
    (Computed) The multi cluster app roles (list)
    targets List<GetMultiClusterAppTarget>
    (Computed) The multi cluster app target projects (list)
    templateName String
    (Computed) The multi cluster app template name (string)
    templateVersion String
    (Computed) The multi cluster app template version (string)
    templateVersionId String
    (Computed) The multi cluster app template version ID (string)
    upgradeStrategies List<GetMultiClusterAppUpgradeStrategy>
    (Computed) The multi cluster app upgrade strategy (list)
    annotations {[key: string]: any}
    (Computed) Annotations for multi cluster app object (map)
    answers GetMultiClusterAppAnswer[]
    (Computed) The multi cluster app answers (list)
    catalogName string
    (Computed) The multi cluster app catalog name (string)
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: any}
    (Computed) Labels for multi cluster app object (map)
    members GetMultiClusterAppMember[]
    (Computed) The multi cluster app members (list)
    name string
    revisionHistoryLimit number
    (Computed) The multi cluster app revision history limit (int)
    revisionId string
    (Computed) Current revision id for the multi cluster app (string)
    roles string[]
    (Computed) The multi cluster app roles (list)
    targets GetMultiClusterAppTarget[]
    (Computed) The multi cluster app target projects (list)
    templateName string
    (Computed) The multi cluster app template name (string)
    templateVersion string
    (Computed) The multi cluster app template version (string)
    templateVersionId string
    (Computed) The multi cluster app template version ID (string)
    upgradeStrategies GetMultiClusterAppUpgradeStrategy[]
    (Computed) The multi cluster app upgrade strategy (list)
    annotations Mapping[str, Any]
    (Computed) Annotations for multi cluster app object (map)
    answers Sequence[GetMultiClusterAppAnswer]
    (Computed) The multi cluster app answers (list)
    catalog_name str
    (Computed) The multi cluster app catalog name (string)
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, Any]
    (Computed) Labels for multi cluster app object (map)
    members Sequence[GetMultiClusterAppMember]
    (Computed) The multi cluster app members (list)
    name str
    revision_history_limit int
    (Computed) The multi cluster app revision history limit (int)
    revision_id str
    (Computed) Current revision id for the multi cluster app (string)
    roles Sequence[str]
    (Computed) The multi cluster app roles (list)
    targets Sequence[GetMultiClusterAppTarget]
    (Computed) The multi cluster app target projects (list)
    template_name str
    (Computed) The multi cluster app template name (string)
    template_version str
    (Computed) The multi cluster app template version (string)
    template_version_id str
    (Computed) The multi cluster app template version ID (string)
    upgrade_strategies Sequence[GetMultiClusterAppUpgradeStrategy]
    (Computed) The multi cluster app upgrade strategy (list)
    annotations Map<Any>
    (Computed) Annotations for multi cluster app object (map)
    answers List<Property Map>
    (Computed) The multi cluster app answers (list)
    catalogName String
    (Computed) The multi cluster app catalog name (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<Any>
    (Computed) Labels for multi cluster app object (map)
    members List<Property Map>
    (Computed) The multi cluster app members (list)
    name String
    revisionHistoryLimit Number
    (Computed) The multi cluster app revision history limit (int)
    revisionId String
    (Computed) Current revision id for the multi cluster app (string)
    roles List<String>
    (Computed) The multi cluster app roles (list)
    targets List<Property Map>
    (Computed) The multi cluster app target projects (list)
    templateName String
    (Computed) The multi cluster app template name (string)
    templateVersion String
    (Computed) The multi cluster app template version (string)
    templateVersionId String
    (Computed) The multi cluster app template version ID (string)
    upgradeStrategies List<Property Map>
    (Computed) The multi cluster app upgrade strategy (list)

    Supporting Types

    GetMultiClusterAppAnswer

    ClusterId string
    Cluster ID for answer
    ProjectId string
    Project ID for answer
    Values Dictionary<string, object>
    Key/values for answer
    ClusterId string
    Cluster ID for answer
    ProjectId string
    Project ID for answer
    Values map[string]interface{}
    Key/values for answer
    clusterId String
    Cluster ID for answer
    projectId String
    Project ID for answer
    values Map<String,Object>
    Key/values for answer
    clusterId string
    Cluster ID for answer
    projectId string
    Project ID for answer
    values {[key: string]: any}
    Key/values for answer
    cluster_id str
    Cluster ID for answer
    project_id str
    Project ID for answer
    values Mapping[str, Any]
    Key/values for answer
    clusterId String
    Cluster ID for answer
    projectId String
    Project ID for answer
    values Map<Any>
    Key/values for answer

    GetMultiClusterAppMember

    AccessType string
    Member access type: member, owner, read-only
    GroupPrincipalId string
    Member group principal id
    UserPrincipalId string
    Member user principal id
    AccessType string
    Member access type: member, owner, read-only
    GroupPrincipalId string
    Member group principal id
    UserPrincipalId string
    Member user principal id
    accessType String
    Member access type: member, owner, read-only
    groupPrincipalId String
    Member group principal id
    userPrincipalId String
    Member user principal id
    accessType string
    Member access type: member, owner, read-only
    groupPrincipalId string
    Member group principal id
    userPrincipalId string
    Member user principal id
    access_type str
    Member access type: member, owner, read-only
    group_principal_id str
    Member group principal id
    user_principal_id str
    Member user principal id
    accessType String
    Member access type: member, owner, read-only
    groupPrincipalId String
    Member group principal id
    userPrincipalId String
    Member user principal id

    GetMultiClusterAppTarget

    AppId string
    App ID for target
    HealthState string
    App health state for target
    ProjectId string
    Project ID for target
    State string
    App state for target
    AppId string
    App ID for target
    HealthState string
    App health state for target
    ProjectId string
    Project ID for target
    State string
    App state for target
    appId String
    App ID for target
    healthState String
    App health state for target
    projectId String
    Project ID for target
    state String
    App state for target
    appId string
    App ID for target
    healthState string
    App health state for target
    projectId string
    Project ID for target
    state string
    App state for target
    app_id str
    App ID for target
    health_state str
    App health state for target
    project_id str
    Project ID for target
    state str
    App state for target
    appId String
    App ID for target
    healthState String
    App health state for target
    projectId String
    Project ID for target
    state String
    App state for target

    GetMultiClusterAppUpgradeStrategy

    rollingUpdate Property Map
    Rolling update for upgrade strategy

    GetMultiClusterAppUpgradeStrategyRollingUpdate

    BatchSize int
    Rolling update batch size
    Interval int
    Rolling update interval
    BatchSize int
    Rolling update batch size
    Interval int
    Rolling update interval
    batchSize Integer
    Rolling update batch size
    interval Integer
    Rolling update interval
    batchSize number
    Rolling update batch size
    interval number
    Rolling update interval
    batch_size int
    Rolling update batch size
    interval int
    Rolling update interval
    batchSize Number
    Rolling update batch size
    interval Number
    Rolling update interval

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v6.1.0 published on Tuesday, Mar 12, 2024 by Pulumi