spectrocloud.ClusterProfile
Explore with Pulumi AI
Import
You can also use the Terraform CLI and the pulumi import
, command to import the cluster using by referencing the resource id
. For example:
$ pulumi import spectrocloud:index/clusterProfile:ClusterProfile example example_id:project
Refer to the Import section to learn more.
Create ClusterProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClusterProfile(name: string, args?: ClusterProfileArgs, opts?: CustomResourceOptions);
@overload
def ClusterProfile(resource_name: str,
args: Optional[ClusterProfileArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ClusterProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
cloud: Optional[str] = None,
cluster_profile_id: Optional[str] = None,
context: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
packs: Optional[Sequence[ClusterProfilePackArgs]] = None,
profile_variables: Optional[ClusterProfileProfileVariablesArgs] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ClusterProfileTimeoutsArgs] = None,
type: Optional[str] = None,
version: Optional[str] = None)
func NewClusterProfile(ctx *Context, name string, args *ClusterProfileArgs, opts ...ResourceOption) (*ClusterProfile, error)
public ClusterProfile(string name, ClusterProfileArgs? args = null, CustomResourceOptions? opts = null)
public ClusterProfile(String name, ClusterProfileArgs args)
public ClusterProfile(String name, ClusterProfileArgs args, CustomResourceOptions options)
type: spectrocloud:ClusterProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ClusterProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterProfileArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterProfileArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var clusterProfileResource = new Spectrocloud.ClusterProfile("clusterProfileResource", new()
{
Cloud = "string",
ClusterProfileId = "string",
Context = "string",
Description = "string",
Name = "string",
Packs = new[]
{
new Spectrocloud.Inputs.ClusterProfilePackArgs
{
Name = "string",
Manifests = new[]
{
new Spectrocloud.Inputs.ClusterProfilePackManifestArgs
{
Content = "string",
Name = "string",
Uid = "string",
},
},
RegistryUid = "string",
Tag = "string",
Type = "string",
Uid = "string",
Values = "string",
},
},
ProfileVariables = new Spectrocloud.Inputs.ClusterProfileProfileVariablesArgs
{
Variables = new[]
{
new Spectrocloud.Inputs.ClusterProfileProfileVariablesVariableArgs
{
DisplayName = "string",
Name = "string",
DefaultValue = "string",
Description = "string",
Format = "string",
Hidden = false,
Immutable = false,
IsSensitive = false,
Regex = "string",
Required = false,
},
},
},
Tags = new[]
{
"string",
},
Timeouts = new Spectrocloud.Inputs.ClusterProfileTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
Type = "string",
Version = "string",
});
example, err := spectrocloud.NewClusterProfile(ctx, "clusterProfileResource", &spectrocloud.ClusterProfileArgs{
Cloud: pulumi.String("string"),
ClusterProfileId: pulumi.String("string"),
Context: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Packs: spectrocloud.ClusterProfilePackArray{
&spectrocloud.ClusterProfilePackArgs{
Name: pulumi.String("string"),
Manifests: spectrocloud.ClusterProfilePackManifestArray{
&spectrocloud.ClusterProfilePackManifestArgs{
Content: pulumi.String("string"),
Name: pulumi.String("string"),
Uid: pulumi.String("string"),
},
},
RegistryUid: pulumi.String("string"),
Tag: pulumi.String("string"),
Type: pulumi.String("string"),
Uid: pulumi.String("string"),
Values: pulumi.String("string"),
},
},
ProfileVariables: &spectrocloud.ClusterProfileProfileVariablesArgs{
Variables: spectrocloud.ClusterProfileProfileVariablesVariableArray{
&spectrocloud.ClusterProfileProfileVariablesVariableArgs{
DisplayName: pulumi.String("string"),
Name: pulumi.String("string"),
DefaultValue: pulumi.String("string"),
Description: pulumi.String("string"),
Format: pulumi.String("string"),
Hidden: pulumi.Bool(false),
Immutable: pulumi.Bool(false),
IsSensitive: pulumi.Bool(false),
Regex: pulumi.String("string"),
Required: pulumi.Bool(false),
},
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &spectrocloud.ClusterProfileTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
Type: pulumi.String("string"),
Version: pulumi.String("string"),
})
var clusterProfileResource = new ClusterProfile("clusterProfileResource", ClusterProfileArgs.builder()
.cloud("string")
.clusterProfileId("string")
.context("string")
.description("string")
.name("string")
.packs(ClusterProfilePackArgs.builder()
.name("string")
.manifests(ClusterProfilePackManifestArgs.builder()
.content("string")
.name("string")
.uid("string")
.build())
.registryUid("string")
.tag("string")
.type("string")
.uid("string")
.values("string")
.build())
.profileVariables(ClusterProfileProfileVariablesArgs.builder()
.variables(ClusterProfileProfileVariablesVariableArgs.builder()
.displayName("string")
.name("string")
.defaultValue("string")
.description("string")
.format("string")
.hidden(false)
.immutable(false)
.isSensitive(false)
.regex("string")
.required(false)
.build())
.build())
.tags("string")
.timeouts(ClusterProfileTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.type("string")
.version("string")
.build());
cluster_profile_resource = spectrocloud.ClusterProfile("clusterProfileResource",
cloud="string",
cluster_profile_id="string",
context="string",
description="string",
name="string",
packs=[{
"name": "string",
"manifests": [{
"content": "string",
"name": "string",
"uid": "string",
}],
"registry_uid": "string",
"tag": "string",
"type": "string",
"uid": "string",
"values": "string",
}],
profile_variables={
"variables": [{
"display_name": "string",
"name": "string",
"default_value": "string",
"description": "string",
"format": "string",
"hidden": False,
"immutable": False,
"is_sensitive": False,
"regex": "string",
"required": False,
}],
},
tags=["string"],
timeouts={
"create": "string",
"delete": "string",
"update": "string",
},
type="string",
version="string")
const clusterProfileResource = new spectrocloud.ClusterProfile("clusterProfileResource", {
cloud: "string",
clusterProfileId: "string",
context: "string",
description: "string",
name: "string",
packs: [{
name: "string",
manifests: [{
content: "string",
name: "string",
uid: "string",
}],
registryUid: "string",
tag: "string",
type: "string",
uid: "string",
values: "string",
}],
profileVariables: {
variables: [{
displayName: "string",
name: "string",
defaultValue: "string",
description: "string",
format: "string",
hidden: false,
immutable: false,
isSensitive: false,
regex: "string",
required: false,
}],
},
tags: ["string"],
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
type: "string",
version: "string",
});
type: spectrocloud:ClusterProfile
properties:
cloud: string
clusterProfileId: string
context: string
description: string
name: string
packs:
- manifests:
- content: string
name: string
uid: string
name: string
registryUid: string
tag: string
type: string
uid: string
values: string
profileVariables:
variables:
- defaultValue: string
description: string
displayName: string
format: string
hidden: false
immutable: false
isSensitive: false
name: string
regex: string
required: false
tags:
- string
timeouts:
create: string
delete: string
update: string
type: string
version: string
ClusterProfile Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ClusterProfile resource accepts the following input properties:
- Cloud string
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - Cluster
Profile stringId - The ID of this resource.
- Context string
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- Name string
- Packs
List<Cluster
Profile Pack> - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - Profile
Variables ClusterProfile Profile Variables - List of variables for the cluster profile.
- List<string>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Profile Timeouts - Type string
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - Version string
- Version of the cluster profile. Defaults to '1.0.0'.
- Cloud string
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - Cluster
Profile stringId - The ID of this resource.
- Context string
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- Name string
- Packs
[]Cluster
Profile Pack Args - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - Profile
Variables ClusterProfile Profile Variables Args - List of variables for the cluster profile.
- []string
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Profile Timeouts Args - Type string
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - Version string
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud String
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster
Profile StringId - The ID of this resource.
- context String
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- name String
- packs
List<Cluster
Profile Pack> - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile
Variables ClusterProfile Profile Variables - List of variables for the cluster profile.
- List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Profile Timeouts - type String
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version String
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud string
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster
Profile stringId - The ID of this resource.
- context string
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description string
- name string
- packs
Cluster
Profile Pack[] - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile
Variables ClusterProfile Profile Variables - List of variables for the cluster profile.
- string[]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Profile Timeouts - type string
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version string
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud str
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster_
profile_ strid - The ID of this resource.
- context str
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description str
- name str
- packs
Sequence[Cluster
Profile Pack Args] - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile_
variables ClusterProfile Profile Variables Args - List of variables for the cluster profile.
- Sequence[str]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Profile Timeouts Args - type str
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version str
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud String
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster
Profile StringId - The ID of this resource.
- context String
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- name String
- packs List<Property Map>
- For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile
Variables Property Map - List of variables for the cluster profile.
- List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts Property Map
- type String
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version String
- Version of the cluster profile. Defaults to '1.0.0'.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterProfile resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ClusterProfile Resource
Get an existing ClusterProfile 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?: ClusterProfileState, opts?: CustomResourceOptions): ClusterProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cloud: Optional[str] = None,
cluster_profile_id: Optional[str] = None,
context: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
packs: Optional[Sequence[ClusterProfilePackArgs]] = None,
profile_variables: Optional[ClusterProfileProfileVariablesArgs] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ClusterProfileTimeoutsArgs] = None,
type: Optional[str] = None,
version: Optional[str] = None) -> ClusterProfile
func GetClusterProfile(ctx *Context, name string, id IDInput, state *ClusterProfileState, opts ...ResourceOption) (*ClusterProfile, error)
public static ClusterProfile Get(string name, Input<string> id, ClusterProfileState? state, CustomResourceOptions? opts = null)
public static ClusterProfile get(String name, Output<String> id, ClusterProfileState state, CustomResourceOptions options)
resources: _: type: spectrocloud:ClusterProfile get: id: ${id}
- 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.
- 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.
- Cloud string
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - Cluster
Profile stringId - The ID of this resource.
- Context string
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- Name string
- Packs
List<Cluster
Profile Pack> - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - Profile
Variables ClusterProfile Profile Variables - List of variables for the cluster profile.
- List<string>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Profile Timeouts - Type string
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - Version string
- Version of the cluster profile. Defaults to '1.0.0'.
- Cloud string
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - Cluster
Profile stringId - The ID of this resource.
- Context string
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - Description string
- Name string
- Packs
[]Cluster
Profile Pack Args - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - Profile
Variables ClusterProfile Profile Variables Args - List of variables for the cluster profile.
- []string
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - Timeouts
Cluster
Profile Timeouts Args - Type string
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - Version string
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud String
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster
Profile StringId - The ID of this resource.
- context String
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- name String
- packs
List<Cluster
Profile Pack> - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile
Variables ClusterProfile Profile Variables - List of variables for the cluster profile.
- List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Profile Timeouts - type String
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version String
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud string
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster
Profile stringId - The ID of this resource.
- context string
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description string
- name string
- packs
Cluster
Profile Pack[] - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile
Variables ClusterProfile Profile Variables - List of variables for the cluster profile.
- string[]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Profile Timeouts - type string
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version string
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud str
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster_
profile_ strid - The ID of this resource.
- context str
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description str
- name str
- packs
Sequence[Cluster
Profile Pack Args] - For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile_
variables ClusterProfile Profile Variables Args - List of variables for the cluster profile.
- Sequence[str]
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts
Cluster
Profile Timeouts Args - type str
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version str
- Version of the cluster profile. Defaults to '1.0.0'.
- cloud String
- Specify the infrastructure provider the cluster profile is for. Only Palette supported infrastructure providers can be used. The supported cloud types are -
all, aws, azure, gcp, vsphere, openstack, maas, virtual, baremetal, eks, aks, edge-native, generic, and gke
or any custom cloud provider registered in Palette, e.g.,nutanix
.If the value is set toall
, then the type must be set toadd-on
. Otherwise, the cluster profile may be incompatible with other providers. Default value isall
. - cluster
Profile StringId - The ID of this resource.
- context String
- The context of the cluster profile. Allowed values are
project
ortenant
. Default value isproject
. If theproject
context is specified, the project name will sourced from the provider configuration parameterproject_name
. - description String
- name String
- packs List<Property Map>
- For packs of type
spectro
,helm
, andmanifest
, at least one pack must be specified. - profile
Variables Property Map - List of variables for the cluster profile.
- List<String>
- A list of tags to be applied to the cluster. Tags must be in the form of
key:value
. - timeouts Property Map
- type String
- Specify the cluster profile type to use. Allowed values are
cluster
,infra
,add-on
, andsystem
. These values map to the following User Interface (UI) labels. Use the value ' cluster ' for a Full cluster profile.For an Infrastructure cluster profile, use the valueinfra
; for an Add-on cluster profile, use the valueadd-on
.System cluster profiles can be specified using the valuesystem
. To learn more about cluster profiles, refer to the Cluster Profile documentation. Default value isadd-on
. - version String
- Version of the cluster profile. Defaults to '1.0.0'.
Supporting Types
ClusterProfilePack, ClusterProfilePackArgs
- Name string
- The name of the pack. The name must be unique within the cluster profile.
- Manifests
List<Cluster
Profile Pack Manifest> - Registry
Uid string - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- Tag string
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - Type string
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - Uid string
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - Values string
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- Name string
- The name of the pack. The name must be unique within the cluster profile.
- Manifests
[]Cluster
Profile Pack Manifest - Registry
Uid string - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- Tag string
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - Type string
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - Uid string
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - Values string
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name String
- The name of the pack. The name must be unique within the cluster profile.
- manifests
List<Cluster
Profile Pack Manifest> - registry
Uid String - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag String
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type String
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid String
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values String
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name string
- The name of the pack. The name must be unique within the cluster profile.
- manifests
Cluster
Profile Pack Manifest[] - registry
Uid string - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag string
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type string
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid string
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values string
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name str
- The name of the pack. The name must be unique within the cluster profile.
- manifests
Sequence[Cluster
Profile Pack Manifest] - registry_
uid str - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag str
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type str
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid str
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values str
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
- name String
- The name of the pack. The name must be unique within the cluster profile.
- manifests List<Property Map>
- registry
Uid String - The registry UID of the pack. The registry UID is the unique identifier of the registry. This attribute is required if there is more than one registry that contains a pack with the same name.
- tag String
- The tag of the pack. The tag is the version of the pack. This attribute is required if the pack type is
spectro
orhelm
. - type String
- The type of the pack. Allowed values are
spectro
,manifest
,helm
, oroci
. The default value is spectro. If using an OCI registry for pack, set the type tooci
. - uid String
- The unique identifier of the pack. The value can be looked up using the
spectrocloud.getPack
data source. This value is required if the pack type isspectro
and forhelm
if the chart is from a public helm registry. - values String
- The values of the pack. The values are the configuration values of the pack. The values are specified in YAML format.
ClusterProfilePackManifest, ClusterProfilePackManifestArgs
ClusterProfileProfileVariables, ClusterProfileProfileVariablesArgs
ClusterProfileProfileVariablesVariable, ClusterProfileProfileVariablesVariableArgs
- Display
Name string - The display name of the variable should be unique among variables.
- Name string
- The name of the variable should be unique among variables.
- Default
Value string - The default value of the variable.
- Description string
- The description of the variable.
- Format string
- The format of the variable. Default is
string
,format
field can only be set during cluster profile creation. Allowed formats includestring
,number
,boolean
,ipv4
,ipv4cidr
,ipv6
,version
. - bool
- If
hidden
is set totrue
, then variable will be hidden for overriding the value. By default thehidden
flag will be set tofalse
. - Immutable bool
- If
immutable
is set totrue
, then variable value can't be editable. By default theimmutable
flag will be set tofalse
. - Is
Sensitive bool - If
is_sensitive
is set totrue
, then default value will be masked. By default theis_sensitive
flag will be set to false. - Regex string
- Regular expression pattern which the variable value must match.
- Required bool
- The
required
to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided.
- Display
Name string - The display name of the variable should be unique among variables.
- Name string
- The name of the variable should be unique among variables.
- Default
Value string - The default value of the variable.
- Description string
- The description of the variable.
- Format string
- The format of the variable. Default is
string
,format
field can only be set during cluster profile creation. Allowed formats includestring
,number
,boolean
,ipv4
,ipv4cidr
,ipv6
,version
. - bool
- If
hidden
is set totrue
, then variable will be hidden for overriding the value. By default thehidden
flag will be set tofalse
. - Immutable bool
- If
immutable
is set totrue
, then variable value can't be editable. By default theimmutable
flag will be set tofalse
. - Is
Sensitive bool - If
is_sensitive
is set totrue
, then default value will be masked. By default theis_sensitive
flag will be set to false. - Regex string
- Regular expression pattern which the variable value must match.
- Required bool
- The
required
to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided.
- display
Name String - The display name of the variable should be unique among variables.
- name String
- The name of the variable should be unique among variables.
- default
Value String - The default value of the variable.
- description String
- The description of the variable.
- format String
- The format of the variable. Default is
string
,format
field can only be set during cluster profile creation. Allowed formats includestring
,number
,boolean
,ipv4
,ipv4cidr
,ipv6
,version
. - Boolean
- If
hidden
is set totrue
, then variable will be hidden for overriding the value. By default thehidden
flag will be set tofalse
. - immutable Boolean
- If
immutable
is set totrue
, then variable value can't be editable. By default theimmutable
flag will be set tofalse
. - is
Sensitive Boolean - If
is_sensitive
is set totrue
, then default value will be masked. By default theis_sensitive
flag will be set to false. - regex String
- Regular expression pattern which the variable value must match.
- required Boolean
- The
required
to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided.
- display
Name string - The display name of the variable should be unique among variables.
- name string
- The name of the variable should be unique among variables.
- default
Value string - The default value of the variable.
- description string
- The description of the variable.
- format string
- The format of the variable. Default is
string
,format
field can only be set during cluster profile creation. Allowed formats includestring
,number
,boolean
,ipv4
,ipv4cidr
,ipv6
,version
. - boolean
- If
hidden
is set totrue
, then variable will be hidden for overriding the value. By default thehidden
flag will be set tofalse
. - immutable boolean
- If
immutable
is set totrue
, then variable value can't be editable. By default theimmutable
flag will be set tofalse
. - is
Sensitive boolean - If
is_sensitive
is set totrue
, then default value will be masked. By default theis_sensitive
flag will be set to false. - regex string
- Regular expression pattern which the variable value must match.
- required boolean
- The
required
to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided.
- display_
name str - The display name of the variable should be unique among variables.
- name str
- The name of the variable should be unique among variables.
- default_
value str - The default value of the variable.
- description str
- The description of the variable.
- format str
- The format of the variable. Default is
string
,format
field can only be set during cluster profile creation. Allowed formats includestring
,number
,boolean
,ipv4
,ipv4cidr
,ipv6
,version
. - bool
- If
hidden
is set totrue
, then variable will be hidden for overriding the value. By default thehidden
flag will be set tofalse
. - immutable bool
- If
immutable
is set totrue
, then variable value can't be editable. By default theimmutable
flag will be set tofalse
. - is_
sensitive bool - If
is_sensitive
is set totrue
, then default value will be masked. By default theis_sensitive
flag will be set to false. - regex str
- Regular expression pattern which the variable value must match.
- required bool
- The
required
to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided.
- display
Name String - The display name of the variable should be unique among variables.
- name String
- The name of the variable should be unique among variables.
- default
Value String - The default value of the variable.
- description String
- The description of the variable.
- format String
- The format of the variable. Default is
string
,format
field can only be set during cluster profile creation. Allowed formats includestring
,number
,boolean
,ipv4
,ipv4cidr
,ipv6
,version
. - Boolean
- If
hidden
is set totrue
, then variable will be hidden for overriding the value. By default thehidden
flag will be set tofalse
. - immutable Boolean
- If
immutable
is set totrue
, then variable value can't be editable. By default theimmutable
flag will be set tofalse
. - is
Sensitive Boolean - If
is_sensitive
is set totrue
, then default value will be masked. By default theis_sensitive
flag will be set to false. - regex String
- Regular expression pattern which the variable value must match.
- required Boolean
- The
required
to specify if the variable is optional or mandatory. If it is mandatory then default value must be provided.
ClusterProfileTimeouts, ClusterProfileTimeoutsArgs
Package Details
- Repository
- spectrocloud spectrocloud/terraform-provider-spectrocloud
- License
- Notes
- This Pulumi package is based on the
spectrocloud
Terraform Provider.