1. Docs
  2. Reference
  3. API
  4. Rancher 2
  5. MultiClusterApp

MultiClusterApp

Create a MultiClusterApp Resource

new MultiClusterApp(name: string, args: MultiClusterAppArgs, opts?: CustomResourceOptions);
def MultiClusterApp(resource_name, opts=None, annotations=None, answers=None, catalog_name=None, labels=None, members=None, name=None, revision_history_limit=None, revision_id=None, roles=None, targets=None, template_name=None, template_version=None, upgrade_strategy=None, wait=None, __props__=None);
func NewMultiClusterApp(ctx *Context, name string, args MultiClusterAppArgs, opts ...ResourceOption) (*MultiClusterApp, error)
public MultiClusterApp(string name, MultiClusterAppArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args MultiClusterAppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args MultiClusterAppArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MultiClusterAppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

MultiClusterApp Resource Properties

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

Inputs

The MultiClusterApp resource accepts the following input properties:

CatalogName string

The multi cluster app catalog name (string)

Roles List<string>

The multi cluster app roles (list)

Targets List<MultiClusterAppTargetArgs>

The multi cluster app target projects (list)

TemplateName string

The multi cluster app template name (string)

Annotations Dictionary<string, object>

Annotations for multi cluster app object (map)

Answers List<MultiClusterAppAnswerArgs>

The multi cluster app answers (list)

Labels Dictionary<string, object>

Labels for multi cluster app object (map)

Members List<MultiClusterAppMemberArgs>

The multi cluster app answers (list)

Name string

The multi cluster app name (string)

RevisionHistoryLimit int

The multi cluster app revision history limit. Default 10 (int)

RevisionId string

Current revision id for the multi cluster app (string)

TemplateVersion string

The multi cluster app template version. Default: latest (string)

UpgradeStrategy MultiClusterAppUpgradeStrategyArgs

The multi cluster app upgrade strategy (list MaxItems:1)

Wait bool

Wait until the multi cluster app is active. Default true (bool)

CatalogName string

The multi cluster app catalog name (string)

Roles []string

The multi cluster app roles (list)

Targets []MultiClusterAppTarget

The multi cluster app target projects (list)

TemplateName string

The multi cluster app template name (string)

Annotations map[string]interface{}

Annotations for multi cluster app object (map)

Answers []MultiClusterAppAnswer

The multi cluster app answers (list)

Labels map[string]interface{}

Labels for multi cluster app object (map)

Members []MultiClusterAppMember

The multi cluster app answers (list)

Name string

The multi cluster app name (string)

RevisionHistoryLimit int

The multi cluster app revision history limit. Default 10 (int)

RevisionId string

Current revision id for the multi cluster app (string)

TemplateVersion string

The multi cluster app template version. Default: latest (string)

UpgradeStrategy MultiClusterAppUpgradeStrategy

The multi cluster app upgrade strategy (list MaxItems:1)

Wait bool

Wait until the multi cluster app is active. Default true (bool)

catalogName string

The multi cluster app catalog name (string)

roles string[]

The multi cluster app roles (list)

targets MultiClusterAppTarget[]

The multi cluster app target projects (list)

templateName string

The multi cluster app template name (string)

annotations {[key: string]: any}

Annotations for multi cluster app object (map)

answers MultiClusterAppAnswer[]

The multi cluster app answers (list)

labels {[key: string]: any}

Labels for multi cluster app object (map)

members MultiClusterAppMember[]

The multi cluster app answers (list)

name string

The multi cluster app name (string)

revisionHistoryLimit number

The multi cluster app revision history limit. Default 10 (int)

revisionId string

Current revision id for the multi cluster app (string)

templateVersion string

The multi cluster app template version. Default: latest (string)

upgradeStrategy MultiClusterAppUpgradeStrategy

The multi cluster app upgrade strategy (list MaxItems:1)

wait boolean

Wait until the multi cluster app is active. Default true (bool)

catalog_name str

The multi cluster app catalog name (string)

roles List[str]

The multi cluster app roles (list)

targets List[MultiClusterAppTarget]

The multi cluster app target projects (list)

template_name str

The multi cluster app template name (string)

annotations Dict[str, Any]

Annotations for multi cluster app object (map)

answers List[MultiClusterAppAnswer]

The multi cluster app answers (list)

labels Dict[str, Any]

Labels for multi cluster app object (map)

members List[MultiClusterAppMember]

The multi cluster app answers (list)

name str

The multi cluster app name (string)

revision_history_limit float

The multi cluster app revision history limit. Default 10 (int)

revision_id str

Current revision id for the multi cluster app (string)

template_version str

The multi cluster app template version. Default: latest (string)

upgrade_strategy Dict[MultiClusterAppUpgradeStrategy]

The multi cluster app upgrade strategy (list MaxItems:1)

wait bool

Wait until the multi cluster app is active. Default true (bool)

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
TemplateVersionId string

(Computed) The multi cluster app template version ID (string)

Id string
The provider-assigned unique ID for this managed resource.
TemplateVersionId string

(Computed) The multi cluster app template version ID (string)

id string
The provider-assigned unique ID for this managed resource.
templateVersionId string

(Computed) The multi cluster app template version ID (string)

id str
The provider-assigned unique ID for this managed resource.
template_version_id str

(Computed) The multi cluster app template version ID (string)

Look up an Existing MultiClusterApp Resource

Get an existing MultiClusterApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MultiClusterAppState, opts?: CustomResourceOptions): MultiClusterApp
static get(resource_name, id, opts=None, annotations=None, answers=None, catalog_name=None, labels=None, members=None, name=None, revision_history_limit=None, revision_id=None, roles=None, targets=None, template_name=None, template_version=None, template_version_id=None, upgrade_strategy=None, wait=None, __props__=None);
func GetMultiClusterApp(ctx *Context, name string, id IDInput, state *MultiClusterAppState, opts ...ResourceOption) (*MultiClusterApp, error)
public static MultiClusterApp Get(string name, Input<string> id, MultiClusterAppState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Annotations Dictionary<string, object>

Annotations for multi cluster app object (map)

Answers List<MultiClusterAppAnswerArgs>

The multi cluster app answers (list)

CatalogName string

The multi cluster app catalog name (string)

Labels Dictionary<string, object>

Labels for multi cluster app object (map)

Members List<MultiClusterAppMemberArgs>

The multi cluster app answers (list)

Name string

The multi cluster app name (string)

RevisionHistoryLimit int

The multi cluster app revision history limit. Default 10 (int)

RevisionId string

Current revision id for the multi cluster app (string)

Roles List<string>

The multi cluster app roles (list)

Targets List<MultiClusterAppTargetArgs>

The multi cluster app target projects (list)

TemplateName string

The multi cluster app template name (string)

TemplateVersion string

The multi cluster app template version. Default: latest (string)

TemplateVersionId string

(Computed) The multi cluster app template version ID (string)

UpgradeStrategy MultiClusterAppUpgradeStrategyArgs

The multi cluster app upgrade strategy (list MaxItems:1)

Wait bool

Wait until the multi cluster app is active. Default true (bool)

Annotations map[string]interface{}

Annotations for multi cluster app object (map)

Answers []MultiClusterAppAnswer

The multi cluster app answers (list)

CatalogName string

The multi cluster app catalog name (string)

Labels map[string]interface{}

Labels for multi cluster app object (map)

Members []MultiClusterAppMember

The multi cluster app answers (list)

Name string

The multi cluster app name (string)

RevisionHistoryLimit int

The multi cluster app revision history limit. Default 10 (int)

RevisionId string

Current revision id for the multi cluster app (string)

Roles []string

The multi cluster app roles (list)

Targets []MultiClusterAppTarget

The multi cluster app target projects (list)

TemplateName string

The multi cluster app template name (string)

TemplateVersion string

The multi cluster app template version. Default: latest (string)

TemplateVersionId string

(Computed) The multi cluster app template version ID (string)

UpgradeStrategy MultiClusterAppUpgradeStrategy

The multi cluster app upgrade strategy (list MaxItems:1)

Wait bool

Wait until the multi cluster app is active. Default true (bool)

annotations {[key: string]: any}

Annotations for multi cluster app object (map)

answers MultiClusterAppAnswer[]

The multi cluster app answers (list)

catalogName string

The multi cluster app catalog name (string)

labels {[key: string]: any}

Labels for multi cluster app object (map)

members MultiClusterAppMember[]

The multi cluster app answers (list)

name string

The multi cluster app name (string)

revisionHistoryLimit number

The multi cluster app revision history limit. Default 10 (int)

revisionId string

Current revision id for the multi cluster app (string)

roles string[]

The multi cluster app roles (list)

targets MultiClusterAppTarget[]

The multi cluster app target projects (list)

templateName string

The multi cluster app template name (string)

templateVersion string

The multi cluster app template version. Default: latest (string)

templateVersionId string

(Computed) The multi cluster app template version ID (string)

upgradeStrategy MultiClusterAppUpgradeStrategy

The multi cluster app upgrade strategy (list MaxItems:1)

wait boolean

Wait until the multi cluster app is active. Default true (bool)

annotations Dict[str, Any]

Annotations for multi cluster app object (map)

answers List[MultiClusterAppAnswer]

The multi cluster app answers (list)

catalog_name str

The multi cluster app catalog name (string)

labels Dict[str, Any]

Labels for multi cluster app object (map)

members List[MultiClusterAppMember]

The multi cluster app answers (list)

name str

The multi cluster app name (string)

revision_history_limit float

The multi cluster app revision history limit. Default 10 (int)

revision_id str

Current revision id for the multi cluster app (string)

roles List[str]

The multi cluster app roles (list)

targets List[MultiClusterAppTarget]

The multi cluster app target projects (list)

template_name str

The multi cluster app template name (string)

template_version str

The multi cluster app template version. Default: latest (string)

template_version_id str

(Computed) The multi cluster app template version ID (string)

upgrade_strategy Dict[MultiClusterAppUpgradeStrategy]

The multi cluster app upgrade strategy (list MaxItems:1)

wait bool

Wait until the multi cluster app is active. Default true (bool)

Supporting Types

MultiClusterAppAnswer

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ClusterId string

Cluster ID for answer (string)

ProjectId string

Project ID for target (string)

Values Dictionary<string, object>

Key/values for answer (map)

ClusterId string

Cluster ID for answer (string)

ProjectId string

Project ID for target (string)

Values map[string]interface{}

Key/values for answer (map)

clusterId string

Cluster ID for answer (string)

projectId string

Project ID for target (string)

values {[key: string]: any}

Key/values for answer (map)

cluster_id str

Cluster ID for answer (string)

project_id str

Project ID for target (string)

values Dict[str, Any]

Key/values for answer (map)

MultiClusterAppMember

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AccessType string

Member access type. Valid values: ["member" | "owner" | "read-only"] (string)

GroupPrincipalId string

Member group principal id (string)

UserPrincipalId string

Member user principal id (string)

AccessType string

Member access type. Valid values: ["member" | "owner" | "read-only"] (string)

GroupPrincipalId string

Member group principal id (string)

UserPrincipalId string

Member user principal id (string)

accessType string

Member access type. Valid values: ["member" | "owner" | "read-only"] (string)

groupPrincipalId string

Member group principal id (string)

userPrincipalId string

Member user principal id (string)

accessType str

Member access type. Valid values: ["member" | "owner" | "read-only"] (string)

group_principal_id str

Member group principal id (string)

user_principal_id str

Member user principal id (string)

MultiClusterAppTarget

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ProjectId string

Project ID for target (string)

AppId string

App ID for target (string)

HealthState string

App health state for target (string)

State string

App state for target (string)

ProjectId string

Project ID for target (string)

AppId string

App ID for target (string)

HealthState string

App health state for target (string)

State string

App state for target (string)

projectId string

Project ID for target (string)

appId string

App ID for target (string)

healthState string

App health state for target (string)

state string

App state for target (string)

project_id str

Project ID for target (string)

appId str

App ID for target (string)

healthState str

App health state for target (string)

state str

App state for target (string)

MultiClusterAppUpgradeStrategy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

RollingUpdate MultiClusterAppUpgradeStrategyRollingUpdateArgs

Upgrade strategy rolling update (list MaxItems:1)

RollingUpdate MultiClusterAppUpgradeStrategyRollingUpdate

Upgrade strategy rolling update (list MaxItems:1)

rollingUpdate MultiClusterAppUpgradeStrategyRollingUpdate

Upgrade strategy rolling update (list MaxItems:1)

rollingUpdate Dict[MultiClusterAppUpgradeStrategyRollingUpdate]

Upgrade strategy rolling update (list MaxItems:1)

MultiClusterAppUpgradeStrategyRollingUpdate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

BatchSize int

Rolling update batch size. Default 1 (int)

Interval int

Rolling update interval. Default 1 (int)

BatchSize int

Rolling update batch size. Default 1 (int)

Interval int

Rolling update interval. Default 1 (int)

batchSize number

Rolling update batch size. Default 1 (int)

interval number

Rolling update interval. Default 1 (int)

batchSize float

Rolling update batch size. Default 1 (int)

interval float

Rolling update interval. Default 1 (int)

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.