Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

ClusterSync

Create a ClusterSync Resource

new ClusterSync(name: string, args: ClusterSyncArgs, opts?: CustomResourceOptions);
def ClusterSync(resource_name: str, opts: Optional[ResourceOptions] = None, cluster_id: Optional[str] = None, node_pool_ids: Optional[Sequence[str]] = None, state_confirm: Optional[int] = None, synced: Optional[bool] = None, wait_monitoring: Optional[bool] = None)
func NewClusterSync(ctx *Context, name string, args ClusterSyncArgs, opts ...ResourceOption) (*ClusterSync, error)
public ClusterSync(string name, ClusterSyncArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ClusterSyncArgs
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 ClusterSyncArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterSyncArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ClusterSync Resource Properties

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

Inputs

The ClusterSync resource accepts the following input properties:

ClusterId string

The cluster ID that is syncing (string)

NodePoolIds List<string>

The node pool IDs used by the cluster id (list)

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

ClusterId string

The cluster ID that is syncing (string)

NodePoolIds []string

The node pool IDs used by the cluster id (list)

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

clusterId string

The cluster ID that is syncing (string)

nodePoolIds string[]

The node pool IDs used by the cluster id (list)

stateConfirm number

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced boolean
waitMonitoring boolean

Wait until monitoring is up and running. Default: false (bool)

cluster_id str

The cluster ID that is syncing (string)

node_pool_ids Sequence[str]

The node pool IDs used by the cluster id (list)

state_confirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced bool
wait_monitoring bool

Wait until monitoring is up and running. Default: false (bool)

Outputs

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

DefaultProjectId string

(Computed) Default project ID for the cluster sync (string)

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

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

SystemProjectId string

(Computed) System project ID for the cluster sync (string)

DefaultProjectId string

(Computed) Default project ID for the cluster sync (string)

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

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

SystemProjectId string

(Computed) System project ID for the cluster sync (string)

defaultProjectId string

(Computed) Default project ID for the cluster sync (string)

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

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

systemProjectId string

(Computed) System project ID for the cluster sync (string)

default_project_id str

(Computed) Default project ID for the cluster sync (string)

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

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

system_project_id str

(Computed) System project ID for the cluster sync (string)

Look up an Existing ClusterSync Resource

Get an existing ClusterSync 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?: ClusterSyncState, opts?: CustomResourceOptions): ClusterSync
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, cluster_id: Optional[str] = None, default_project_id: Optional[str] = None, kube_config: Optional[str] = None, node_pool_ids: Optional[Sequence[str]] = None, state_confirm: Optional[int] = None, synced: Optional[bool] = None, system_project_id: Optional[str] = None, wait_monitoring: Optional[bool] = None) -> ClusterSync
func GetClusterSync(ctx *Context, name string, id IDInput, state *ClusterSyncState, opts ...ResourceOption) (*ClusterSync, error)
public static ClusterSync Get(string name, Input<string> id, ClusterSyncState? 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:

ClusterId string

The cluster ID that is syncing (string)

DefaultProjectId string

(Computed) Default project ID for the cluster sync (string)

KubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

NodePoolIds List<string>

The node pool IDs used by the cluster id (list)

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
SystemProjectId string

(Computed) System project ID for the cluster sync (string)

WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

ClusterId string

The cluster ID that is syncing (string)

DefaultProjectId string

(Computed) Default project ID for the cluster sync (string)

KubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

NodePoolIds []string

The node pool IDs used by the cluster id (list)

StateConfirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

Synced bool
SystemProjectId string

(Computed) System project ID for the cluster sync (string)

WaitMonitoring bool

Wait until monitoring is up and running. Default: false (bool)

clusterId string

The cluster ID that is syncing (string)

defaultProjectId string

(Computed) Default project ID for the cluster sync (string)

kubeConfig string

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

nodePoolIds string[]

The node pool IDs used by the cluster id (list)

stateConfirm number

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced boolean
systemProjectId string

(Computed) System project ID for the cluster sync (string)

waitMonitoring boolean

Wait until monitoring is up and running. Default: false (bool)

cluster_id str

The cluster ID that is syncing (string)

default_project_id str

(Computed) Default project ID for the cluster sync (string)

kube_config str

(Computed/Sensitive) Kube Config generated for the cluster sync (string)

node_pool_ids Sequence[str]

The node pool IDs used by the cluster id (list)

state_confirm int

Wait until active status is confirmed a number of times (wait interval of 5s). Default: 1 means no confirmation (int)

synced bool
system_project_id str

(Computed) System project ID for the cluster sync (string)

wait_monitoring bool

Wait until monitoring is up and running. Default: false (bool)

Package Details

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