1. Packages
  2. Spectrocloud Provider
  3. API Docs
  4. ClusterAks
spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud

spectrocloud.ClusterAks

Explore with Pulumi AI

Resource for managing AKS clusters in Spectro Cloud through Palette.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as spectrocloud from "@pulumi/spectrocloud";

const account = spectrocloud.getCloudaccountAzure({
    name: _var.cluster_cloud_account_name,
});
const profile = spectrocloud.getClusterProfile({
    name: _var.cluster_cluster_profile_name,
});
const bsl = spectrocloud.getBackupStorageLocation({
    name: _var.backup_storage_location_name,
});
const cluster = new spectrocloud.ClusterAks("cluster", {
    tags: [
        "dev",
        "department:devops",
        "owner:bob",
    ],
    cloudAccountId: account.then(account => account.id),
    cloudConfig: {
        subscriptionId: "subscription-id",
        resourceGroup: "dev",
        sshKey: "ssh key value",
        region: "centralus",
    },
    clusterProfiles: [{
        id: profile.then(profile => profile.id),
    }],
    backupPolicy: {
        schedule: "0 0 * * SUN",
        backupLocationId: bsl.then(bsl => bsl.id),
        prefix: "prod-backup",
        expiryInHour: 7200,
        includeDisks: true,
        includeClusterResources: true,
    },
    scanPolicy: {
        configurationScanSchedule: "0 0 * * SUN",
        penetrationScanSchedule: "0 0 * * SUN",
        conformanceScanSchedule: "0 0 1 * *",
    },
    machinePools: [{
        name: "worker-basic",
        count: 1,
        instanceType: "Standard_DS4",
        diskSizeGb: 60,
        isSystemNodePool: true,
        storageAccountType: "Standard_LRS",
    }],
});
Copy
import pulumi
import pulumi_spectrocloud as spectrocloud

account = spectrocloud.get_cloudaccount_azure(name=var["cluster_cloud_account_name"])
profile = spectrocloud.get_cluster_profile(name=var["cluster_cluster_profile_name"])
bsl = spectrocloud.get_backup_storage_location(name=var["backup_storage_location_name"])
cluster = spectrocloud.ClusterAks("cluster",
    tags=[
        "dev",
        "department:devops",
        "owner:bob",
    ],
    cloud_account_id=account.id,
    cloud_config={
        "subscription_id": "subscription-id",
        "resource_group": "dev",
        "ssh_key": "ssh key value",
        "region": "centralus",
    },
    cluster_profiles=[{
        "id": profile.id,
    }],
    backup_policy={
        "schedule": "0 0 * * SUN",
        "backup_location_id": bsl.id,
        "prefix": "prod-backup",
        "expiry_in_hour": 7200,
        "include_disks": True,
        "include_cluster_resources": True,
    },
    scan_policy={
        "configuration_scan_schedule": "0 0 * * SUN",
        "penetration_scan_schedule": "0 0 * * SUN",
        "conformance_scan_schedule": "0 0 1 * *",
    },
    machine_pools=[{
        "name": "worker-basic",
        "count": 1,
        "instance_type": "Standard_DS4",
        "disk_size_gb": 60,
        "is_system_node_pool": True,
        "storage_account_type": "Standard_LRS",
    }])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/spectrocloud/spectrocloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		account, err := spectrocloud.LookupCloudaccountAzure(ctx, &spectrocloud.LookupCloudaccountAzureArgs{
			Name: pulumi.StringRef(_var.Cluster_cloud_account_name),
		}, nil)
		if err != nil {
			return err
		}
		profile, err := spectrocloud.LookupClusterProfile(ctx, &spectrocloud.LookupClusterProfileArgs{
			Name: pulumi.StringRef(_var.Cluster_cluster_profile_name),
		}, nil)
		if err != nil {
			return err
		}
		bsl, err := spectrocloud.LookupBackupStorageLocation(ctx, &spectrocloud.LookupBackupStorageLocationArgs{
			Name: pulumi.StringRef(_var.Backup_storage_location_name),
		}, nil)
		if err != nil {
			return err
		}
		_, err = spectrocloud.NewClusterAks(ctx, "cluster", &spectrocloud.ClusterAksArgs{
			Tags: pulumi.StringArray{
				pulumi.String("dev"),
				pulumi.String("department:devops"),
				pulumi.String("owner:bob"),
			},
			CloudAccountId: pulumi.String(account.Id),
			CloudConfig: &spectrocloud.ClusterAksCloudConfigArgs{
				SubscriptionId: pulumi.String("subscription-id"),
				ResourceGroup:  pulumi.String("dev"),
				SshKey:         pulumi.String("ssh key value"),
				Region:         pulumi.String("centralus"),
			},
			ClusterProfiles: spectrocloud.ClusterAksClusterProfileArray{
				&spectrocloud.ClusterAksClusterProfileArgs{
					Id: pulumi.String(profile.Id),
				},
			},
			BackupPolicy: &spectrocloud.ClusterAksBackupPolicyArgs{
				Schedule:                pulumi.String("0 0 * * SUN"),
				BackupLocationId:        pulumi.String(bsl.Id),
				Prefix:                  pulumi.String("prod-backup"),
				ExpiryInHour:            pulumi.Float64(7200),
				IncludeDisks:            pulumi.Bool(true),
				IncludeClusterResources: pulumi.Bool(true),
			},
			ScanPolicy: &spectrocloud.ClusterAksScanPolicyArgs{
				ConfigurationScanSchedule: pulumi.String("0 0 * * SUN"),
				PenetrationScanSchedule:   pulumi.String("0 0 * * SUN"),
				ConformanceScanSchedule:   pulumi.String("0 0 1 * *"),
			},
			MachinePools: spectrocloud.ClusterAksMachinePoolArray{
				&spectrocloud.ClusterAksMachinePoolArgs{
					Name:               pulumi.String("worker-basic"),
					Count:              pulumi.Float64(1),
					InstanceType:       pulumi.String("Standard_DS4"),
					DiskSizeGb:         pulumi.Float64(60),
					IsSystemNodePool:   pulumi.Bool(true),
					StorageAccountType: pulumi.String("Standard_LRS"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Spectrocloud = Pulumi.Spectrocloud;

return await Deployment.RunAsync(() => 
{
    var account = Spectrocloud.GetCloudaccountAzure.Invoke(new()
    {
        Name = @var.Cluster_cloud_account_name,
    });

    var profile = Spectrocloud.GetClusterProfile.Invoke(new()
    {
        Name = @var.Cluster_cluster_profile_name,
    });

    var bsl = Spectrocloud.GetBackupStorageLocation.Invoke(new()
    {
        Name = @var.Backup_storage_location_name,
    });

    var cluster = new Spectrocloud.ClusterAks("cluster", new()
    {
        Tags = new[]
        {
            "dev",
            "department:devops",
            "owner:bob",
        },
        CloudAccountId = account.Apply(getCloudaccountAzureResult => getCloudaccountAzureResult.Id),
        CloudConfig = new Spectrocloud.Inputs.ClusterAksCloudConfigArgs
        {
            SubscriptionId = "subscription-id",
            ResourceGroup = "dev",
            SshKey = "ssh key value",
            Region = "centralus",
        },
        ClusterProfiles = new[]
        {
            new Spectrocloud.Inputs.ClusterAksClusterProfileArgs
            {
                Id = profile.Apply(getClusterProfileResult => getClusterProfileResult.Id),
            },
        },
        BackupPolicy = new Spectrocloud.Inputs.ClusterAksBackupPolicyArgs
        {
            Schedule = "0 0 * * SUN",
            BackupLocationId = bsl.Apply(getBackupStorageLocationResult => getBackupStorageLocationResult.Id),
            Prefix = "prod-backup",
            ExpiryInHour = 7200,
            IncludeDisks = true,
            IncludeClusterResources = true,
        },
        ScanPolicy = new Spectrocloud.Inputs.ClusterAksScanPolicyArgs
        {
            ConfigurationScanSchedule = "0 0 * * SUN",
            PenetrationScanSchedule = "0 0 * * SUN",
            ConformanceScanSchedule = "0 0 1 * *",
        },
        MachinePools = new[]
        {
            new Spectrocloud.Inputs.ClusterAksMachinePoolArgs
            {
                Name = "worker-basic",
                Count = 1,
                InstanceType = "Standard_DS4",
                DiskSizeGb = 60,
                IsSystemNodePool = true,
                StorageAccountType = "Standard_LRS",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.spectrocloud.SpectrocloudFunctions;
import com.pulumi.spectrocloud.inputs.GetCloudaccountAzureArgs;
import com.pulumi.spectrocloud.inputs.GetClusterProfileArgs;
import com.pulumi.spectrocloud.inputs.GetBackupStorageLocationArgs;
import com.pulumi.spectrocloud.ClusterAks;
import com.pulumi.spectrocloud.ClusterAksArgs;
import com.pulumi.spectrocloud.inputs.ClusterAksCloudConfigArgs;
import com.pulumi.spectrocloud.inputs.ClusterAksClusterProfileArgs;
import com.pulumi.spectrocloud.inputs.ClusterAksBackupPolicyArgs;
import com.pulumi.spectrocloud.inputs.ClusterAksScanPolicyArgs;
import com.pulumi.spectrocloud.inputs.ClusterAksMachinePoolArgs;
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 account = SpectrocloudFunctions.getCloudaccountAzure(GetCloudaccountAzureArgs.builder()
            .name(var_.cluster_cloud_account_name())
            .build());

        final var profile = SpectrocloudFunctions.getClusterProfile(GetClusterProfileArgs.builder()
            .name(var_.cluster_cluster_profile_name())
            .build());

        final var bsl = SpectrocloudFunctions.getBackupStorageLocation(GetBackupStorageLocationArgs.builder()
            .name(var_.backup_storage_location_name())
            .build());

        var cluster = new ClusterAks("cluster", ClusterAksArgs.builder()
            .tags(            
                "dev",
                "department:devops",
                "owner:bob")
            .cloudAccountId(account.applyValue(getCloudaccountAzureResult -> getCloudaccountAzureResult.id()))
            .cloudConfig(ClusterAksCloudConfigArgs.builder()
                .subscriptionId("subscription-id")
                .resourceGroup("dev")
                .sshKey("ssh key value")
                .region("centralus")
                .build())
            .clusterProfiles(ClusterAksClusterProfileArgs.builder()
                .id(profile.applyValue(getClusterProfileResult -> getClusterProfileResult.id()))
                .build())
            .backupPolicy(ClusterAksBackupPolicyArgs.builder()
                .schedule("0 0 * * SUN")
                .backupLocationId(bsl.applyValue(getBackupStorageLocationResult -> getBackupStorageLocationResult.id()))
                .prefix("prod-backup")
                .expiryInHour(7200)
                .includeDisks(true)
                .includeClusterResources(true)
                .build())
            .scanPolicy(ClusterAksScanPolicyArgs.builder()
                .configurationScanSchedule("0 0 * * SUN")
                .penetrationScanSchedule("0 0 * * SUN")
                .conformanceScanSchedule("0 0 1 * *")
                .build())
            .machinePools(ClusterAksMachinePoolArgs.builder()
                .name("worker-basic")
                .count(1)
                .instanceType("Standard_DS4")
                .diskSizeGb(60)
                .isSystemNodePool(true)
                .storageAccountType("Standard_LRS")
                .build())
            .build());

    }
}
Copy
resources:
  cluster:
    type: spectrocloud:ClusterAks
    properties:
      tags:
        - dev
        - department:devops
        - owner:bob
      cloudAccountId: ${account.id}
      cloudConfig:
        subscriptionId: subscription-id
        resourceGroup: dev
        sshKey: ssh key value
        region: centralus
      clusterProfiles:
        - id: ${profile.id}
      backupPolicy:
        schedule: 0 0 * * SUN
        backupLocationId: ${bsl.id}
        prefix: prod-backup
        expiryInHour: 7200
        includeDisks: true
        includeClusterResources: true
      scanPolicy:
        configurationScanSchedule: 0 0 * * SUN
        penetrationScanSchedule: 0 0 * * SUN
        conformanceScanSchedule: 0 0 1 * *
      machinePools:
        - name: worker-basic
          count: 1
          instanceType: Standard_DS4
          diskSizeGb: 60
          isSystemNodePool: true
          storageAccountType: Standard_LRS
variables:
  account:
    fn::invoke:
      function: spectrocloud:getCloudaccountAzure
      arguments:
        name: ${var.cluster_cloud_account_name}
  profile:
    fn::invoke:
      function: spectrocloud:getClusterProfile
      arguments:
        name: ${var.cluster_cluster_profile_name}
  bsl:
    fn::invoke:
      function: spectrocloud:getBackupStorageLocation
      arguments:
        name: ${var.backup_storage_location_name}
Copy

Create ClusterAks Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ClusterAks(name: string, args: ClusterAksArgs, opts?: CustomResourceOptions);
@overload
def ClusterAks(resource_name: str,
               args: ClusterAksArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def ClusterAks(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               cloud_config: Optional[ClusterAksCloudConfigArgs] = None,
               machine_pools: Optional[Sequence[ClusterAksMachinePoolArgs]] = None,
               cloud_account_id: Optional[str] = None,
               host_configs: Optional[Sequence[ClusterAksHostConfigArgs]] = None,
               name: Optional[str] = None,
               cluster_meta_attribute: Optional[str] = None,
               cluster_profiles: Optional[Sequence[ClusterAksClusterProfileArgs]] = None,
               cluster_rbac_bindings: Optional[Sequence[ClusterAksClusterRbacBindingArgs]] = None,
               context: Optional[str] = None,
               description: Optional[str] = None,
               force_delete: Optional[bool] = None,
               force_delete_delay: Optional[float] = None,
               apply_setting: Optional[str] = None,
               backup_policy: Optional[ClusterAksBackupPolicyArgs] = None,
               cluster_aks_id: Optional[str] = None,
               namespaces: Optional[Sequence[ClusterAksNamespaceArgs]] = None,
               os_patch_after: Optional[str] = None,
               os_patch_on_boot: Optional[bool] = None,
               os_patch_schedule: Optional[str] = None,
               pause_agent_upgrades: Optional[str] = None,
               review_repave_state: Optional[str] = None,
               scan_policy: Optional[ClusterAksScanPolicyArgs] = None,
               skip_completion: Optional[bool] = None,
               tags: Optional[Sequence[str]] = None,
               timeouts: Optional[ClusterAksTimeoutsArgs] = None)
func NewClusterAks(ctx *Context, name string, args ClusterAksArgs, opts ...ResourceOption) (*ClusterAks, error)
public ClusterAks(string name, ClusterAksArgs args, CustomResourceOptions? opts = null)
public ClusterAks(String name, ClusterAksArgs args)
public ClusterAks(String name, ClusterAksArgs args, CustomResourceOptions options)
type: spectrocloud:ClusterAks
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ClusterAksArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ClusterAksArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterAksArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClusterAksArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClusterAksArgs
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 clusterAksResource = new Spectrocloud.ClusterAks("clusterAksResource", new()
{
    CloudConfig = new Spectrocloud.Inputs.ClusterAksCloudConfigArgs
    {
        Region = "string",
        SubscriptionId = "string",
        SshKey = "string",
        ResourceGroup = "string",
        PrivateCluster = false,
        ControlPlaneCidr = "string",
        ControlPlaneSubnetSecurityGroupName = "string",
        ControlPlaneSubnetName = "string",
        VnetCidrBlock = "string",
        VnetName = "string",
        VnetResourceGroup = "string",
        WorkerCidr = "string",
        WorkerSubnetName = "string",
        WorkerSubnetSecurityGroupName = "string",
    },
    MachinePools = new[]
    {
        new Spectrocloud.Inputs.ClusterAksMachinePoolArgs
        {
            Count = 0,
            DiskSizeGb = 0,
            InstanceType = "string",
            IsSystemNodePool = false,
            Name = "string",
            StorageAccountType = "string",
            AdditionalLabels = 
            {
                { "string", "string" },
            },
            Max = 0,
            Min = 0,
            Nodes = new[]
            {
                new Spectrocloud.Inputs.ClusterAksMachinePoolNodeArgs
                {
                    Action = "string",
                    NodeId = "string",
                },
            },
            Taints = new[]
            {
                new Spectrocloud.Inputs.ClusterAksMachinePoolTaintArgs
                {
                    Effect = "string",
                    Key = "string",
                    Value = "string",
                },
            },
            UpdateStrategy = "string",
        },
    },
    CloudAccountId = "string",
    HostConfigs = new[]
    {
        new Spectrocloud.Inputs.ClusterAksHostConfigArgs
        {
            ExternalTrafficPolicy = "string",
            HostEndpointType = "string",
            IngressHost = "string",
            LoadBalancerSourceRanges = "string",
        },
    },
    Name = "string",
    ClusterMetaAttribute = "string",
    ClusterProfiles = new[]
    {
        new Spectrocloud.Inputs.ClusterAksClusterProfileArgs
        {
            Id = "string",
            Packs = new[]
            {
                new Spectrocloud.Inputs.ClusterAksClusterProfilePackArgs
                {
                    Name = "string",
                    Manifests = new[]
                    {
                        new Spectrocloud.Inputs.ClusterAksClusterProfilePackManifestArgs
                        {
                            Content = "string",
                            Name = "string",
                            Uid = "string",
                        },
                    },
                    RegistryUid = "string",
                    Tag = "string",
                    Type = "string",
                    Uid = "string",
                    Values = "string",
                },
            },
            Variables = 
            {
                { "string", "string" },
            },
        },
    },
    ClusterRbacBindings = new[]
    {
        new Spectrocloud.Inputs.ClusterAksClusterRbacBindingArgs
        {
            Type = "string",
            Namespace = "string",
            Role = 
            {
                { "string", "string" },
            },
            Subjects = new[]
            {
                new Spectrocloud.Inputs.ClusterAksClusterRbacBindingSubjectArgs
                {
                    Name = "string",
                    Type = "string",
                    Namespace = "string",
                },
            },
        },
    },
    Context = "string",
    Description = "string",
    ForceDelete = false,
    ForceDeleteDelay = 0,
    ApplySetting = "string",
    BackupPolicy = new Spectrocloud.Inputs.ClusterAksBackupPolicyArgs
    {
        BackupLocationId = "string",
        ExpiryInHour = 0,
        Prefix = "string",
        Schedule = "string",
        ClusterUids = new[]
        {
            "string",
        },
        IncludeAllClusters = false,
        IncludeClusterResources = false,
        IncludeClusterResourcesMode = "string",
        IncludeDisks = false,
        Namespaces = new[]
        {
            "string",
        },
    },
    ClusterAksId = "string",
    Namespaces = new[]
    {
        new Spectrocloud.Inputs.ClusterAksNamespaceArgs
        {
            Name = "string",
            ResourceAllocation = 
            {
                { "string", "string" },
            },
            ImagesBlacklists = new[]
            {
                "string",
            },
        },
    },
    OsPatchAfter = "string",
    OsPatchOnBoot = false,
    OsPatchSchedule = "string",
    PauseAgentUpgrades = "string",
    ReviewRepaveState = "string",
    ScanPolicy = new Spectrocloud.Inputs.ClusterAksScanPolicyArgs
    {
        ConfigurationScanSchedule = "string",
        ConformanceScanSchedule = "string",
        PenetrationScanSchedule = "string",
    },
    SkipCompletion = false,
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Spectrocloud.Inputs.ClusterAksTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := spectrocloud.NewClusterAks(ctx, "clusterAksResource", &spectrocloud.ClusterAksArgs{
	CloudConfig: &spectrocloud.ClusterAksCloudConfigArgs{
		Region:                              pulumi.String("string"),
		SubscriptionId:                      pulumi.String("string"),
		SshKey:                              pulumi.String("string"),
		ResourceGroup:                       pulumi.String("string"),
		PrivateCluster:                      pulumi.Bool(false),
		ControlPlaneCidr:                    pulumi.String("string"),
		ControlPlaneSubnetSecurityGroupName: pulumi.String("string"),
		ControlPlaneSubnetName:              pulumi.String("string"),
		VnetCidrBlock:                       pulumi.String("string"),
		VnetName:                            pulumi.String("string"),
		VnetResourceGroup:                   pulumi.String("string"),
		WorkerCidr:                          pulumi.String("string"),
		WorkerSubnetName:                    pulumi.String("string"),
		WorkerSubnetSecurityGroupName:       pulumi.String("string"),
	},
	MachinePools: spectrocloud.ClusterAksMachinePoolArray{
		&spectrocloud.ClusterAksMachinePoolArgs{
			Count:              pulumi.Float64(0),
			DiskSizeGb:         pulumi.Float64(0),
			InstanceType:       pulumi.String("string"),
			IsSystemNodePool:   pulumi.Bool(false),
			Name:               pulumi.String("string"),
			StorageAccountType: pulumi.String("string"),
			AdditionalLabels: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Max: pulumi.Float64(0),
			Min: pulumi.Float64(0),
			Nodes: spectrocloud.ClusterAksMachinePoolNodeArray{
				&spectrocloud.ClusterAksMachinePoolNodeArgs{
					Action: pulumi.String("string"),
					NodeId: pulumi.String("string"),
				},
			},
			Taints: spectrocloud.ClusterAksMachinePoolTaintArray{
				&spectrocloud.ClusterAksMachinePoolTaintArgs{
					Effect: pulumi.String("string"),
					Key:    pulumi.String("string"),
					Value:  pulumi.String("string"),
				},
			},
			UpdateStrategy: pulumi.String("string"),
		},
	},
	CloudAccountId: pulumi.String("string"),
	HostConfigs: spectrocloud.ClusterAksHostConfigArray{
		&spectrocloud.ClusterAksHostConfigArgs{
			ExternalTrafficPolicy:    pulumi.String("string"),
			HostEndpointType:         pulumi.String("string"),
			IngressHost:              pulumi.String("string"),
			LoadBalancerSourceRanges: pulumi.String("string"),
		},
	},
	Name:                 pulumi.String("string"),
	ClusterMetaAttribute: pulumi.String("string"),
	ClusterProfiles: spectrocloud.ClusterAksClusterProfileArray{
		&spectrocloud.ClusterAksClusterProfileArgs{
			Id: pulumi.String("string"),
			Packs: spectrocloud.ClusterAksClusterProfilePackArray{
				&spectrocloud.ClusterAksClusterProfilePackArgs{
					Name: pulumi.String("string"),
					Manifests: spectrocloud.ClusterAksClusterProfilePackManifestArray{
						&spectrocloud.ClusterAksClusterProfilePackManifestArgs{
							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"),
				},
			},
			Variables: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
	ClusterRbacBindings: spectrocloud.ClusterAksClusterRbacBindingArray{
		&spectrocloud.ClusterAksClusterRbacBindingArgs{
			Type:      pulumi.String("string"),
			Namespace: pulumi.String("string"),
			Role: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Subjects: spectrocloud.ClusterAksClusterRbacBindingSubjectArray{
				&spectrocloud.ClusterAksClusterRbacBindingSubjectArgs{
					Name:      pulumi.String("string"),
					Type:      pulumi.String("string"),
					Namespace: pulumi.String("string"),
				},
			},
		},
	},
	Context:          pulumi.String("string"),
	Description:      pulumi.String("string"),
	ForceDelete:      pulumi.Bool(false),
	ForceDeleteDelay: pulumi.Float64(0),
	ApplySetting:     pulumi.String("string"),
	BackupPolicy: &spectrocloud.ClusterAksBackupPolicyArgs{
		BackupLocationId: pulumi.String("string"),
		ExpiryInHour:     pulumi.Float64(0),
		Prefix:           pulumi.String("string"),
		Schedule:         pulumi.String("string"),
		ClusterUids: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludeAllClusters:          pulumi.Bool(false),
		IncludeClusterResources:     pulumi.Bool(false),
		IncludeClusterResourcesMode: pulumi.String("string"),
		IncludeDisks:                pulumi.Bool(false),
		Namespaces: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ClusterAksId: pulumi.String("string"),
	Namespaces: spectrocloud.ClusterAksNamespaceArray{
		&spectrocloud.ClusterAksNamespaceArgs{
			Name: pulumi.String("string"),
			ResourceAllocation: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ImagesBlacklists: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	OsPatchAfter:       pulumi.String("string"),
	OsPatchOnBoot:      pulumi.Bool(false),
	OsPatchSchedule:    pulumi.String("string"),
	PauseAgentUpgrades: pulumi.String("string"),
	ReviewRepaveState:  pulumi.String("string"),
	ScanPolicy: &spectrocloud.ClusterAksScanPolicyArgs{
		ConfigurationScanSchedule: pulumi.String("string"),
		ConformanceScanSchedule:   pulumi.String("string"),
		PenetrationScanSchedule:   pulumi.String("string"),
	},
	SkipCompletion: pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &spectrocloud.ClusterAksTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})
Copy
var clusterAksResource = new ClusterAks("clusterAksResource", ClusterAksArgs.builder()
    .cloudConfig(ClusterAksCloudConfigArgs.builder()
        .region("string")
        .subscriptionId("string")
        .sshKey("string")
        .resourceGroup("string")
        .privateCluster(false)
        .controlPlaneCidr("string")
        .controlPlaneSubnetSecurityGroupName("string")
        .controlPlaneSubnetName("string")
        .vnetCidrBlock("string")
        .vnetName("string")
        .vnetResourceGroup("string")
        .workerCidr("string")
        .workerSubnetName("string")
        .workerSubnetSecurityGroupName("string")
        .build())
    .machinePools(ClusterAksMachinePoolArgs.builder()
        .count(0)
        .diskSizeGb(0)
        .instanceType("string")
        .isSystemNodePool(false)
        .name("string")
        .storageAccountType("string")
        .additionalLabels(Map.of("string", "string"))
        .max(0)
        .min(0)
        .nodes(ClusterAksMachinePoolNodeArgs.builder()
            .action("string")
            .nodeId("string")
            .build())
        .taints(ClusterAksMachinePoolTaintArgs.builder()
            .effect("string")
            .key("string")
            .value("string")
            .build())
        .updateStrategy("string")
        .build())
    .cloudAccountId("string")
    .hostConfigs(ClusterAksHostConfigArgs.builder()
        .externalTrafficPolicy("string")
        .hostEndpointType("string")
        .ingressHost("string")
        .loadBalancerSourceRanges("string")
        .build())
    .name("string")
    .clusterMetaAttribute("string")
    .clusterProfiles(ClusterAksClusterProfileArgs.builder()
        .id("string")
        .packs(ClusterAksClusterProfilePackArgs.builder()
            .name("string")
            .manifests(ClusterAksClusterProfilePackManifestArgs.builder()
                .content("string")
                .name("string")
                .uid("string")
                .build())
            .registryUid("string")
            .tag("string")
            .type("string")
            .uid("string")
            .values("string")
            .build())
        .variables(Map.of("string", "string"))
        .build())
    .clusterRbacBindings(ClusterAksClusterRbacBindingArgs.builder()
        .type("string")
        .namespace("string")
        .role(Map.of("string", "string"))
        .subjects(ClusterAksClusterRbacBindingSubjectArgs.builder()
            .name("string")
            .type("string")
            .namespace("string")
            .build())
        .build())
    .context("string")
    .description("string")
    .forceDelete(false)
    .forceDeleteDelay(0)
    .applySetting("string")
    .backupPolicy(ClusterAksBackupPolicyArgs.builder()
        .backupLocationId("string")
        .expiryInHour(0)
        .prefix("string")
        .schedule("string")
        .clusterUids("string")
        .includeAllClusters(false)
        .includeClusterResources(false)
        .includeClusterResourcesMode("string")
        .includeDisks(false)
        .namespaces("string")
        .build())
    .clusterAksId("string")
    .namespaces(ClusterAksNamespaceArgs.builder()
        .name("string")
        .resourceAllocation(Map.of("string", "string"))
        .imagesBlacklists("string")
        .build())
    .osPatchAfter("string")
    .osPatchOnBoot(false)
    .osPatchSchedule("string")
    .pauseAgentUpgrades("string")
    .reviewRepaveState("string")
    .scanPolicy(ClusterAksScanPolicyArgs.builder()
        .configurationScanSchedule("string")
        .conformanceScanSchedule("string")
        .penetrationScanSchedule("string")
        .build())
    .skipCompletion(false)
    .tags("string")
    .timeouts(ClusterAksTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
cluster_aks_resource = spectrocloud.ClusterAks("clusterAksResource",
    cloud_config={
        "region": "string",
        "subscription_id": "string",
        "ssh_key": "string",
        "resource_group": "string",
        "private_cluster": False,
        "control_plane_cidr": "string",
        "control_plane_subnet_security_group_name": "string",
        "control_plane_subnet_name": "string",
        "vnet_cidr_block": "string",
        "vnet_name": "string",
        "vnet_resource_group": "string",
        "worker_cidr": "string",
        "worker_subnet_name": "string",
        "worker_subnet_security_group_name": "string",
    },
    machine_pools=[{
        "count": 0,
        "disk_size_gb": 0,
        "instance_type": "string",
        "is_system_node_pool": False,
        "name": "string",
        "storage_account_type": "string",
        "additional_labels": {
            "string": "string",
        },
        "max": 0,
        "min": 0,
        "nodes": [{
            "action": "string",
            "node_id": "string",
        }],
        "taints": [{
            "effect": "string",
            "key": "string",
            "value": "string",
        }],
        "update_strategy": "string",
    }],
    cloud_account_id="string",
    host_configs=[{
        "external_traffic_policy": "string",
        "host_endpoint_type": "string",
        "ingress_host": "string",
        "load_balancer_source_ranges": "string",
    }],
    name="string",
    cluster_meta_attribute="string",
    cluster_profiles=[{
        "id": "string",
        "packs": [{
            "name": "string",
            "manifests": [{
                "content": "string",
                "name": "string",
                "uid": "string",
            }],
            "registry_uid": "string",
            "tag": "string",
            "type": "string",
            "uid": "string",
            "values": "string",
        }],
        "variables": {
            "string": "string",
        },
    }],
    cluster_rbac_bindings=[{
        "type": "string",
        "namespace": "string",
        "role": {
            "string": "string",
        },
        "subjects": [{
            "name": "string",
            "type": "string",
            "namespace": "string",
        }],
    }],
    context="string",
    description="string",
    force_delete=False,
    force_delete_delay=0,
    apply_setting="string",
    backup_policy={
        "backup_location_id": "string",
        "expiry_in_hour": 0,
        "prefix": "string",
        "schedule": "string",
        "cluster_uids": ["string"],
        "include_all_clusters": False,
        "include_cluster_resources": False,
        "include_cluster_resources_mode": "string",
        "include_disks": False,
        "namespaces": ["string"],
    },
    cluster_aks_id="string",
    namespaces=[{
        "name": "string",
        "resource_allocation": {
            "string": "string",
        },
        "images_blacklists": ["string"],
    }],
    os_patch_after="string",
    os_patch_on_boot=False,
    os_patch_schedule="string",
    pause_agent_upgrades="string",
    review_repave_state="string",
    scan_policy={
        "configuration_scan_schedule": "string",
        "conformance_scan_schedule": "string",
        "penetration_scan_schedule": "string",
    },
    skip_completion=False,
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const clusterAksResource = new spectrocloud.ClusterAks("clusterAksResource", {
    cloudConfig: {
        region: "string",
        subscriptionId: "string",
        sshKey: "string",
        resourceGroup: "string",
        privateCluster: false,
        controlPlaneCidr: "string",
        controlPlaneSubnetSecurityGroupName: "string",
        controlPlaneSubnetName: "string",
        vnetCidrBlock: "string",
        vnetName: "string",
        vnetResourceGroup: "string",
        workerCidr: "string",
        workerSubnetName: "string",
        workerSubnetSecurityGroupName: "string",
    },
    machinePools: [{
        count: 0,
        diskSizeGb: 0,
        instanceType: "string",
        isSystemNodePool: false,
        name: "string",
        storageAccountType: "string",
        additionalLabels: {
            string: "string",
        },
        max: 0,
        min: 0,
        nodes: [{
            action: "string",
            nodeId: "string",
        }],
        taints: [{
            effect: "string",
            key: "string",
            value: "string",
        }],
        updateStrategy: "string",
    }],
    cloudAccountId: "string",
    hostConfigs: [{
        externalTrafficPolicy: "string",
        hostEndpointType: "string",
        ingressHost: "string",
        loadBalancerSourceRanges: "string",
    }],
    name: "string",
    clusterMetaAttribute: "string",
    clusterProfiles: [{
        id: "string",
        packs: [{
            name: "string",
            manifests: [{
                content: "string",
                name: "string",
                uid: "string",
            }],
            registryUid: "string",
            tag: "string",
            type: "string",
            uid: "string",
            values: "string",
        }],
        variables: {
            string: "string",
        },
    }],
    clusterRbacBindings: [{
        type: "string",
        namespace: "string",
        role: {
            string: "string",
        },
        subjects: [{
            name: "string",
            type: "string",
            namespace: "string",
        }],
    }],
    context: "string",
    description: "string",
    forceDelete: false,
    forceDeleteDelay: 0,
    applySetting: "string",
    backupPolicy: {
        backupLocationId: "string",
        expiryInHour: 0,
        prefix: "string",
        schedule: "string",
        clusterUids: ["string"],
        includeAllClusters: false,
        includeClusterResources: false,
        includeClusterResourcesMode: "string",
        includeDisks: false,
        namespaces: ["string"],
    },
    clusterAksId: "string",
    namespaces: [{
        name: "string",
        resourceAllocation: {
            string: "string",
        },
        imagesBlacklists: ["string"],
    }],
    osPatchAfter: "string",
    osPatchOnBoot: false,
    osPatchSchedule: "string",
    pauseAgentUpgrades: "string",
    reviewRepaveState: "string",
    scanPolicy: {
        configurationScanSchedule: "string",
        conformanceScanSchedule: "string",
        penetrationScanSchedule: "string",
    },
    skipCompletion: false,
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: spectrocloud:ClusterAks
properties:
    applySetting: string
    backupPolicy:
        backupLocationId: string
        clusterUids:
            - string
        expiryInHour: 0
        includeAllClusters: false
        includeClusterResources: false
        includeClusterResourcesMode: string
        includeDisks: false
        namespaces:
            - string
        prefix: string
        schedule: string
    cloudAccountId: string
    cloudConfig:
        controlPlaneCidr: string
        controlPlaneSubnetName: string
        controlPlaneSubnetSecurityGroupName: string
        privateCluster: false
        region: string
        resourceGroup: string
        sshKey: string
        subscriptionId: string
        vnetCidrBlock: string
        vnetName: string
        vnetResourceGroup: string
        workerCidr: string
        workerSubnetName: string
        workerSubnetSecurityGroupName: string
    clusterAksId: string
    clusterMetaAttribute: string
    clusterProfiles:
        - id: string
          packs:
            - manifests:
                - content: string
                  name: string
                  uid: string
              name: string
              registryUid: string
              tag: string
              type: string
              uid: string
              values: string
          variables:
            string: string
    clusterRbacBindings:
        - namespace: string
          role:
            string: string
          subjects:
            - name: string
              namespace: string
              type: string
          type: string
    context: string
    description: string
    forceDelete: false
    forceDeleteDelay: 0
    hostConfigs:
        - externalTrafficPolicy: string
          hostEndpointType: string
          ingressHost: string
          loadBalancerSourceRanges: string
    machinePools:
        - additionalLabels:
            string: string
          count: 0
          diskSizeGb: 0
          instanceType: string
          isSystemNodePool: false
          max: 0
          min: 0
          name: string
          nodes:
            - action: string
              nodeId: string
          storageAccountType: string
          taints:
            - effect: string
              key: string
              value: string
          updateStrategy: string
    name: string
    namespaces:
        - imagesBlacklists:
            - string
          name: string
          resourceAllocation:
            string: string
    osPatchAfter: string
    osPatchOnBoot: false
    osPatchSchedule: string
    pauseAgentUpgrades: string
    reviewRepaveState: string
    scanPolicy:
        configurationScanSchedule: string
        conformanceScanSchedule: string
        penetrationScanSchedule: string
    skipCompletion: false
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
Copy

ClusterAks 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 ClusterAks resource accepts the following input properties:

CloudAccountId This property is required. string
CloudConfig This property is required. ClusterAksCloudConfig
MachinePools This property is required. List<ClusterAksMachinePool>
ApplySetting string
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
BackupPolicy ClusterAksBackupPolicy
The backup policy for the cluster. If not specified, no backups will be taken.
ClusterAksId string
The ID of this resource.
ClusterMetaAttribute string
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
ClusterProfiles List<ClusterAksClusterProfile>
ClusterRbacBindings List<ClusterAksClusterRbacBinding>
The RBAC binding for the cluster.
Context string
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
Description string
The description of the cluster. Default value is empty string.
ForceDelete bool
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
ForceDeleteDelay double
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
HostConfigs List<ClusterAksHostConfig>
The host configuration for the cluster.
Name string
Namespaces List<ClusterAksNamespace>
The namespaces for the cluster.
OsPatchAfter string
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
OsPatchOnBoot bool
Whether to apply OS patch on boot. Default is false.
OsPatchSchedule string
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
PauseAgentUpgrades string
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
ReviewRepaveState string
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
ScanPolicy ClusterAksScanPolicy
The scan policy for the cluster.
SkipCompletion bool
If true, the cluster will be created asynchronously. Default value is false.
Tags List<string>
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
Timeouts ClusterAksTimeouts
CloudAccountId This property is required. string
CloudConfig This property is required. ClusterAksCloudConfigArgs
MachinePools This property is required. []ClusterAksMachinePoolArgs
ApplySetting string
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
BackupPolicy ClusterAksBackupPolicyArgs
The backup policy for the cluster. If not specified, no backups will be taken.
ClusterAksId string
The ID of this resource.
ClusterMetaAttribute string
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
ClusterProfiles []ClusterAksClusterProfileArgs
ClusterRbacBindings []ClusterAksClusterRbacBindingArgs
The RBAC binding for the cluster.
Context string
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
Description string
The description of the cluster. Default value is empty string.
ForceDelete bool
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
ForceDeleteDelay float64
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
HostConfigs []ClusterAksHostConfigArgs
The host configuration for the cluster.
Name string
Namespaces []ClusterAksNamespaceArgs
The namespaces for the cluster.
OsPatchAfter string
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
OsPatchOnBoot bool
Whether to apply OS patch on boot. Default is false.
OsPatchSchedule string
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
PauseAgentUpgrades string
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
ReviewRepaveState string
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
ScanPolicy ClusterAksScanPolicyArgs
The scan policy for the cluster.
SkipCompletion bool
If true, the cluster will be created asynchronously. Default value is false.
Tags []string
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
Timeouts ClusterAksTimeoutsArgs
cloudAccountId This property is required. String
cloudConfig This property is required. ClusterAksCloudConfig
machinePools This property is required. List<ClusterAksMachinePool>
applySetting String
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backupPolicy ClusterAksBackupPolicy
The backup policy for the cluster. If not specified, no backups will be taken.
clusterAksId String
The ID of this resource.
clusterMetaAttribute String
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
clusterProfiles List<ClusterAksClusterProfile>
clusterRbacBindings List<ClusterAksClusterRbacBinding>
The RBAC binding for the cluster.
context String
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description String
The description of the cluster. Default value is empty string.
forceDelete Boolean
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
forceDeleteDelay Double
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
hostConfigs List<ClusterAksHostConfig>
The host configuration for the cluster.
name String
namespaces List<ClusterAksNamespace>
The namespaces for the cluster.
osPatchAfter String
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
osPatchOnBoot Boolean
Whether to apply OS patch on boot. Default is false.
osPatchSchedule String
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pauseAgentUpgrades String
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
reviewRepaveState String
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scanPolicy ClusterAksScanPolicy
The scan policy for the cluster.
skipCompletion Boolean
If true, the cluster will be created asynchronously. Default value is false.
tags List<String>
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts ClusterAksTimeouts
cloudAccountId This property is required. string
cloudConfig This property is required. ClusterAksCloudConfig
machinePools This property is required. ClusterAksMachinePool[]
applySetting string
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backupPolicy ClusterAksBackupPolicy
The backup policy for the cluster. If not specified, no backups will be taken.
clusterAksId string
The ID of this resource.
clusterMetaAttribute string
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
clusterProfiles ClusterAksClusterProfile[]
clusterRbacBindings ClusterAksClusterRbacBinding[]
The RBAC binding for the cluster.
context string
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description string
The description of the cluster. Default value is empty string.
forceDelete boolean
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
forceDeleteDelay number
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
hostConfigs ClusterAksHostConfig[]
The host configuration for the cluster.
name string
namespaces ClusterAksNamespace[]
The namespaces for the cluster.
osPatchAfter string
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
osPatchOnBoot boolean
Whether to apply OS patch on boot. Default is false.
osPatchSchedule string
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pauseAgentUpgrades string
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
reviewRepaveState string
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scanPolicy ClusterAksScanPolicy
The scan policy for the cluster.
skipCompletion boolean
If true, the cluster will be created asynchronously. Default value is false.
tags string[]
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts ClusterAksTimeouts
cloud_account_id This property is required. str
cloud_config This property is required. ClusterAksCloudConfigArgs
machine_pools This property is required. Sequence[ClusterAksMachinePoolArgs]
apply_setting str
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backup_policy ClusterAksBackupPolicyArgs
The backup policy for the cluster. If not specified, no backups will be taken.
cluster_aks_id str
The ID of this resource.
cluster_meta_attribute str
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
cluster_profiles Sequence[ClusterAksClusterProfileArgs]
cluster_rbac_bindings Sequence[ClusterAksClusterRbacBindingArgs]
The RBAC binding for the cluster.
context str
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description str
The description of the cluster. Default value is empty string.
force_delete bool
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
force_delete_delay float
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
host_configs Sequence[ClusterAksHostConfigArgs]
The host configuration for the cluster.
name str
namespaces Sequence[ClusterAksNamespaceArgs]
The namespaces for the cluster.
os_patch_after str
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
os_patch_on_boot bool
Whether to apply OS patch on boot. Default is false.
os_patch_schedule str
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pause_agent_upgrades str
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
review_repave_state str
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scan_policy ClusterAksScanPolicyArgs
The scan policy for the cluster.
skip_completion bool
If true, the cluster will be created asynchronously. Default value is false.
tags Sequence[str]
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts ClusterAksTimeoutsArgs
cloudAccountId This property is required. String
cloudConfig This property is required. Property Map
machinePools This property is required. List<Property Map>
applySetting String
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backupPolicy Property Map
The backup policy for the cluster. If not specified, no backups will be taken.
clusterAksId String
The ID of this resource.
clusterMetaAttribute String
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
clusterProfiles List<Property Map>
clusterRbacBindings List<Property Map>
The RBAC binding for the cluster.
context String
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description String
The description of the cluster. Default value is empty string.
forceDelete Boolean
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
forceDeleteDelay Number
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
hostConfigs List<Property Map>
The host configuration for the cluster.
name String
namespaces List<Property Map>
The namespaces for the cluster.
osPatchAfter String
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
osPatchOnBoot Boolean
Whether to apply OS patch on boot. Default is false.
osPatchSchedule String
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pauseAgentUpgrades String
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
reviewRepaveState String
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scanPolicy Property Map
The scan policy for the cluster.
skipCompletion Boolean
If true, the cluster will be created asynchronously. Default value is false.
tags List<String>
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts Property Map

Outputs

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

AdminKubeConfig string
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
CloudConfigId string
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

Id string
The provider-assigned unique ID for this managed resource.
Kubeconfig string
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
LocationConfigs List<ClusterAksLocationConfig>
The location of the cluster.
AdminKubeConfig string
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
CloudConfigId string
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

Id string
The provider-assigned unique ID for this managed resource.
Kubeconfig string
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
LocationConfigs []ClusterAksLocationConfig
The location of the cluster.
adminKubeConfig String
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
cloudConfigId String
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

id String
The provider-assigned unique ID for this managed resource.
kubeconfig String
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
locationConfigs List<ClusterAksLocationConfig>
The location of the cluster.
adminKubeConfig string
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
cloudConfigId string
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

id string
The provider-assigned unique ID for this managed resource.
kubeconfig string
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
locationConfigs ClusterAksLocationConfig[]
The location of the cluster.
admin_kube_config str
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
cloud_config_id str
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

id str
The provider-assigned unique ID for this managed resource.
kubeconfig str
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
location_configs Sequence[ClusterAksLocationConfig]
The location of the cluster.
adminKubeConfig String
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
cloudConfigId String
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

id String
The provider-assigned unique ID for this managed resource.
kubeconfig String
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
locationConfigs List<Property Map>
The location of the cluster.

Look up Existing ClusterAks Resource

Get an existing ClusterAks 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?: ClusterAksState, opts?: CustomResourceOptions): ClusterAks
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_kube_config: Optional[str] = None,
        apply_setting: Optional[str] = None,
        backup_policy: Optional[ClusterAksBackupPolicyArgs] = None,
        cloud_account_id: Optional[str] = None,
        cloud_config: Optional[ClusterAksCloudConfigArgs] = None,
        cloud_config_id: Optional[str] = None,
        cluster_aks_id: Optional[str] = None,
        cluster_meta_attribute: Optional[str] = None,
        cluster_profiles: Optional[Sequence[ClusterAksClusterProfileArgs]] = None,
        cluster_rbac_bindings: Optional[Sequence[ClusterAksClusterRbacBindingArgs]] = None,
        context: Optional[str] = None,
        description: Optional[str] = None,
        force_delete: Optional[bool] = None,
        force_delete_delay: Optional[float] = None,
        host_configs: Optional[Sequence[ClusterAksHostConfigArgs]] = None,
        kubeconfig: Optional[str] = None,
        location_configs: Optional[Sequence[ClusterAksLocationConfigArgs]] = None,
        machine_pools: Optional[Sequence[ClusterAksMachinePoolArgs]] = None,
        name: Optional[str] = None,
        namespaces: Optional[Sequence[ClusterAksNamespaceArgs]] = None,
        os_patch_after: Optional[str] = None,
        os_patch_on_boot: Optional[bool] = None,
        os_patch_schedule: Optional[str] = None,
        pause_agent_upgrades: Optional[str] = None,
        review_repave_state: Optional[str] = None,
        scan_policy: Optional[ClusterAksScanPolicyArgs] = None,
        skip_completion: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[ClusterAksTimeoutsArgs] = None) -> ClusterAks
func GetClusterAks(ctx *Context, name string, id IDInput, state *ClusterAksState, opts ...ResourceOption) (*ClusterAks, error)
public static ClusterAks Get(string name, Input<string> id, ClusterAksState? state, CustomResourceOptions? opts = null)
public static ClusterAks get(String name, Output<String> id, ClusterAksState state, CustomResourceOptions options)
resources:  _:    type: spectrocloud:ClusterAks    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AdminKubeConfig string
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
ApplySetting string
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
BackupPolicy ClusterAksBackupPolicy
The backup policy for the cluster. If not specified, no backups will be taken.
CloudAccountId string
CloudConfig ClusterAksCloudConfig
CloudConfigId string
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

ClusterAksId string
The ID of this resource.
ClusterMetaAttribute string
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
ClusterProfiles List<ClusterAksClusterProfile>
ClusterRbacBindings List<ClusterAksClusterRbacBinding>
The RBAC binding for the cluster.
Context string
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
Description string
The description of the cluster. Default value is empty string.
ForceDelete bool
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
ForceDeleteDelay double
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
HostConfigs List<ClusterAksHostConfig>
The host configuration for the cluster.
Kubeconfig string
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
LocationConfigs List<ClusterAksLocationConfig>
The location of the cluster.
MachinePools List<ClusterAksMachinePool>
Name string
Namespaces List<ClusterAksNamespace>
The namespaces for the cluster.
OsPatchAfter string
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
OsPatchOnBoot bool
Whether to apply OS patch on boot. Default is false.
OsPatchSchedule string
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
PauseAgentUpgrades string
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
ReviewRepaveState string
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
ScanPolicy ClusterAksScanPolicy
The scan policy for the cluster.
SkipCompletion bool
If true, the cluster will be created asynchronously. Default value is false.
Tags List<string>
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
Timeouts ClusterAksTimeouts
AdminKubeConfig string
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
ApplySetting string
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
BackupPolicy ClusterAksBackupPolicyArgs
The backup policy for the cluster. If not specified, no backups will be taken.
CloudAccountId string
CloudConfig ClusterAksCloudConfigArgs
CloudConfigId string
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

ClusterAksId string
The ID of this resource.
ClusterMetaAttribute string
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
ClusterProfiles []ClusterAksClusterProfileArgs
ClusterRbacBindings []ClusterAksClusterRbacBindingArgs
The RBAC binding for the cluster.
Context string
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
Description string
The description of the cluster. Default value is empty string.
ForceDelete bool
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
ForceDeleteDelay float64
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
HostConfigs []ClusterAksHostConfigArgs
The host configuration for the cluster.
Kubeconfig string
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
LocationConfigs []ClusterAksLocationConfigArgs
The location of the cluster.
MachinePools []ClusterAksMachinePoolArgs
Name string
Namespaces []ClusterAksNamespaceArgs
The namespaces for the cluster.
OsPatchAfter string
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
OsPatchOnBoot bool
Whether to apply OS patch on boot. Default is false.
OsPatchSchedule string
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
PauseAgentUpgrades string
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
ReviewRepaveState string
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
ScanPolicy ClusterAksScanPolicyArgs
The scan policy for the cluster.
SkipCompletion bool
If true, the cluster will be created asynchronously. Default value is false.
Tags []string
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
Timeouts ClusterAksTimeoutsArgs
adminKubeConfig String
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
applySetting String
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backupPolicy ClusterAksBackupPolicy
The backup policy for the cluster. If not specified, no backups will be taken.
cloudAccountId String
cloudConfig ClusterAksCloudConfig
cloudConfigId String
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

clusterAksId String
The ID of this resource.
clusterMetaAttribute String
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
clusterProfiles List<ClusterAksClusterProfile>
clusterRbacBindings List<ClusterAksClusterRbacBinding>
The RBAC binding for the cluster.
context String
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description String
The description of the cluster. Default value is empty string.
forceDelete Boolean
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
forceDeleteDelay Double
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
hostConfigs List<ClusterAksHostConfig>
The host configuration for the cluster.
kubeconfig String
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
locationConfigs List<ClusterAksLocationConfig>
The location of the cluster.
machinePools List<ClusterAksMachinePool>
name String
namespaces List<ClusterAksNamespace>
The namespaces for the cluster.
osPatchAfter String
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
osPatchOnBoot Boolean
Whether to apply OS patch on boot. Default is false.
osPatchSchedule String
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pauseAgentUpgrades String
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
reviewRepaveState String
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scanPolicy ClusterAksScanPolicy
The scan policy for the cluster.
skipCompletion Boolean
If true, the cluster will be created asynchronously. Default value is false.
tags List<String>
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts ClusterAksTimeouts
adminKubeConfig string
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
applySetting string
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backupPolicy ClusterAksBackupPolicy
The backup policy for the cluster. If not specified, no backups will be taken.
cloudAccountId string
cloudConfig ClusterAksCloudConfig
cloudConfigId string
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

clusterAksId string
The ID of this resource.
clusterMetaAttribute string
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
clusterProfiles ClusterAksClusterProfile[]
clusterRbacBindings ClusterAksClusterRbacBinding[]
The RBAC binding for the cluster.
context string
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description string
The description of the cluster. Default value is empty string.
forceDelete boolean
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
forceDeleteDelay number
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
hostConfigs ClusterAksHostConfig[]
The host configuration for the cluster.
kubeconfig string
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
locationConfigs ClusterAksLocationConfig[]
The location of the cluster.
machinePools ClusterAksMachinePool[]
name string
namespaces ClusterAksNamespace[]
The namespaces for the cluster.
osPatchAfter string
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
osPatchOnBoot boolean
Whether to apply OS patch on boot. Default is false.
osPatchSchedule string
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pauseAgentUpgrades string
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
reviewRepaveState string
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scanPolicy ClusterAksScanPolicy
The scan policy for the cluster.
skipCompletion boolean
If true, the cluster will be created asynchronously. Default value is false.
tags string[]
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts ClusterAksTimeouts
admin_kube_config str
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
apply_setting str
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backup_policy ClusterAksBackupPolicyArgs
The backup policy for the cluster. If not specified, no backups will be taken.
cloud_account_id str
cloud_config ClusterAksCloudConfigArgs
cloud_config_id str
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

cluster_aks_id str
The ID of this resource.
cluster_meta_attribute str
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
cluster_profiles Sequence[ClusterAksClusterProfileArgs]
cluster_rbac_bindings Sequence[ClusterAksClusterRbacBindingArgs]
The RBAC binding for the cluster.
context str
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description str
The description of the cluster. Default value is empty string.
force_delete bool
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
force_delete_delay float
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
host_configs Sequence[ClusterAksHostConfigArgs]
The host configuration for the cluster.
kubeconfig str
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
location_configs Sequence[ClusterAksLocationConfigArgs]
The location of the cluster.
machine_pools Sequence[ClusterAksMachinePoolArgs]
name str
namespaces Sequence[ClusterAksNamespaceArgs]
The namespaces for the cluster.
os_patch_after str
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
os_patch_on_boot bool
Whether to apply OS patch on boot. Default is false.
os_patch_schedule str
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pause_agent_upgrades str
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
review_repave_state str
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scan_policy ClusterAksScanPolicyArgs
The scan policy for the cluster.
skip_completion bool
If true, the cluster will be created asynchronously. Default value is false.
tags Sequence[str]
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts ClusterAksTimeoutsArgs
adminKubeConfig String
Admin Kube-config for the cluster. This can be used to connect to the cluster using kubectl, With admin privilege.
applySetting String
The setting to apply the cluster profile. DownloadAndInstall will download and install packs in one action. DownloadAndInstallLater will only download artifact and postpone install for later. Default value is DownloadAndInstall.
backupPolicy Property Map
The backup policy for the cluster. If not specified, no backups will be taken.
cloudAccountId String
cloudConfig Property Map
cloudConfigId String
ID of the cloud config used for the cluster. This cloud config must be of type azure.

Deprecated: Deprecated

clusterAksId String
The ID of this resource.
clusterMetaAttribute String
cluster_meta_attribute can be used to set additional cluster metadata information, eg {'nic_name': 'test', 'env': 'stage'}
clusterProfiles List<Property Map>
clusterRbacBindings List<Property Map>
The RBAC binding for the cluster.
context String
The context of the AKS cluster. Allowed values are project or tenant. Default is project. If the project context is specified, the project name will sourced from the provider configuration parameter project_name.
description String
The description of the cluster. Default value is empty string.
forceDelete Boolean
If set to true, the cluster will be force deleted and user has to manually clean up the provisioned cloud resources.
forceDeleteDelay Number
Delay duration in minutes to before invoking cluster force delete. Default and minimum is 20.
hostConfigs List<Property Map>
The host configuration for the cluster.
kubeconfig String
Kubeconfig for the cluster. This can be used to connect to the cluster using kubectl.
locationConfigs List<Property Map>
The location of the cluster.
machinePools List<Property Map>
name String
namespaces List<Property Map>
The namespaces for the cluster.
osPatchAfter String
The date and time after which to patch the cluster. Prefix the time value with the respective RFC. Ex: RFC3339: 2006-01-02T15:04:05Z07:00
osPatchOnBoot Boolean
Whether to apply OS patch on boot. Default is false.
osPatchSchedule String
The cron schedule for OS patching. This must be in the form of cron syntax. Ex: 0 0 * * *.
pauseAgentUpgrades String
The pause agent upgrades setting allows to control the automatic upgrade of the Palette component and agent for an individual cluster. The default value is unlock, meaning upgrades occur automatically. Setting it to lock pauses automatic agent upgrades for the cluster.
reviewRepaveState String
To authorize the cluster repave, set the value to Approved for approval and "" to decline. Default value is "".
scanPolicy Property Map
The scan policy for the cluster.
skipCompletion Boolean
If true, the cluster will be created asynchronously. Default value is false.
tags List<String>
A list of tags to be applied to the cluster. Tags must be in the form of key:value.
timeouts Property Map

Supporting Types

ClusterAksBackupPolicy
, ClusterAksBackupPolicyArgs

BackupLocationId This property is required. string
The ID of the backup location to use for the backup.
ExpiryInHour This property is required. double
The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
Prefix This property is required. string
Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
Schedule This property is required. string
The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to 0 1 * * *.
ClusterUids List<string>
The list of cluster UIDs to include in the backup. If include_all_clusters is set to true, then all clusters will be included.
IncludeAllClusters bool
Whether to include all clusters in the backup. If set to false, only the clusters specified in cluster_uids will be included.
IncludeClusterResources bool
Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
IncludeClusterResourcesMode string
Specifies whether to include the cluster resources in the backup. Supported values are always, never, and auto.
IncludeDisks bool
Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
Namespaces List<string>
The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
BackupLocationId This property is required. string
The ID of the backup location to use for the backup.
ExpiryInHour This property is required. float64
The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
Prefix This property is required. string
Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
Schedule This property is required. string
The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to 0 1 * * *.
ClusterUids []string
The list of cluster UIDs to include in the backup. If include_all_clusters is set to true, then all clusters will be included.
IncludeAllClusters bool
Whether to include all clusters in the backup. If set to false, only the clusters specified in cluster_uids will be included.
IncludeClusterResources bool
Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
IncludeClusterResourcesMode string
Specifies whether to include the cluster resources in the backup. Supported values are always, never, and auto.
IncludeDisks bool
Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
Namespaces []string
The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
backupLocationId This property is required. String
The ID of the backup location to use for the backup.
expiryInHour This property is required. Double
The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
prefix This property is required. String
Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
schedule This property is required. String
The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to 0 1 * * *.
clusterUids List<String>
The list of cluster UIDs to include in the backup. If include_all_clusters is set to true, then all clusters will be included.
includeAllClusters Boolean
Whether to include all clusters in the backup. If set to false, only the clusters specified in cluster_uids will be included.
includeClusterResources Boolean
Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
includeClusterResourcesMode String
Specifies whether to include the cluster resources in the backup. Supported values are always, never, and auto.
includeDisks Boolean
Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
namespaces List<String>
The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
backupLocationId This property is required. string
The ID of the backup location to use for the backup.
expiryInHour This property is required. number
The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
prefix This property is required. string
Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
schedule This property is required. string
The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to 0 1 * * *.
clusterUids string[]
The list of cluster UIDs to include in the backup. If include_all_clusters is set to true, then all clusters will be included.
includeAllClusters boolean
Whether to include all clusters in the backup. If set to false, only the clusters specified in cluster_uids will be included.
includeClusterResources boolean
Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
includeClusterResourcesMode string
Specifies whether to include the cluster resources in the backup. Supported values are always, never, and auto.
includeDisks boolean
Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
namespaces string[]
The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
backup_location_id This property is required. str
The ID of the backup location to use for the backup.
expiry_in_hour This property is required. float
The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
prefix This property is required. str
Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
schedule This property is required. str
The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to 0 1 * * *.
cluster_uids Sequence[str]
The list of cluster UIDs to include in the backup. If include_all_clusters is set to true, then all clusters will be included.
include_all_clusters bool
Whether to include all clusters in the backup. If set to false, only the clusters specified in cluster_uids will be included.
include_cluster_resources bool
Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
include_cluster_resources_mode str
Specifies whether to include the cluster resources in the backup. Supported values are always, never, and auto.
include_disks bool
Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
namespaces Sequence[str]
The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.
backupLocationId This property is required. String
The ID of the backup location to use for the backup.
expiryInHour This property is required. Number
The number of hours after which the backup will be deleted. For example, if the expiry is set to 24, the backup will be deleted after 24 hours.
prefix This property is required. String
Prefix for the backup name. The backup name will be of the format \n\n-\n\n-\n\n.
schedule This property is required. String
The schedule for the backup. The schedule is specified in cron format. For example, to run the backup every day at 1:00 AM, the schedule should be set to 0 1 * * *.
clusterUids List<String>
The list of cluster UIDs to include in the backup. If include_all_clusters is set to true, then all clusters will be included.
includeAllClusters Boolean
Whether to include all clusters in the backup. If set to false, only the clusters specified in cluster_uids will be included.
includeClusterResources Boolean
Indicates whether to include cluster resources in the backup. If set to false, only the cluster configuration and disks will be backed up. (Note: Starting with Palette version 4.6, the includeclusterresources attribute will be deprecated, and a new attribute, includeclusterresources_mode, will be introduced.)
includeClusterResourcesMode String
Specifies whether to include the cluster resources in the backup. Supported values are always, never, and auto.
includeDisks Boolean
Whether to include the disks in the backup. If set to false, only the cluster configuration will be backed up.
namespaces List<String>
The list of Kubernetes namespaces to include in the backup. If not specified, all namespaces will be included.

ClusterAksCloudConfig
, ClusterAksCloudConfigArgs

Region This property is required. string
ResourceGroup This property is required. string
SshKey This property is required. string
Public SSH key to be used for the cluster nodes.
SubscriptionId This property is required. string
ControlPlaneCidr string
ControlPlaneSubnetName string
ControlPlaneSubnetSecurityGroupName string
PrivateCluster bool
Whether to create a private cluster(API endpoint). Default is false.
VnetCidrBlock string
VnetName string
VnetResourceGroup string
WorkerCidr string
WorkerSubnetName string
WorkerSubnetSecurityGroupName string
Region This property is required. string
ResourceGroup This property is required. string
SshKey This property is required. string
Public SSH key to be used for the cluster nodes.
SubscriptionId This property is required. string
ControlPlaneCidr string
ControlPlaneSubnetName string
ControlPlaneSubnetSecurityGroupName string
PrivateCluster bool
Whether to create a private cluster(API endpoint). Default is false.
VnetCidrBlock string
VnetName string
VnetResourceGroup string
WorkerCidr string
WorkerSubnetName string
WorkerSubnetSecurityGroupName string
region This property is required. String
resourceGroup This property is required. String
sshKey This property is required. String
Public SSH key to be used for the cluster nodes.
subscriptionId This property is required. String
controlPlaneCidr String
controlPlaneSubnetName String
controlPlaneSubnetSecurityGroupName String
privateCluster Boolean
Whether to create a private cluster(API endpoint). Default is false.
vnetCidrBlock String
vnetName String
vnetResourceGroup String
workerCidr String
workerSubnetName String
workerSubnetSecurityGroupName String
region This property is required. string
resourceGroup This property is required. string
sshKey This property is required. string
Public SSH key to be used for the cluster nodes.
subscriptionId This property is required. string
controlPlaneCidr string
controlPlaneSubnetName string
controlPlaneSubnetSecurityGroupName string
privateCluster boolean
Whether to create a private cluster(API endpoint). Default is false.
vnetCidrBlock string
vnetName string
vnetResourceGroup string
workerCidr string
workerSubnetName string
workerSubnetSecurityGroupName string
region This property is required. str
resource_group This property is required. str
ssh_key This property is required. str
Public SSH key to be used for the cluster nodes.
subscription_id This property is required. str
control_plane_cidr str
control_plane_subnet_name str
control_plane_subnet_security_group_name str
private_cluster bool
Whether to create a private cluster(API endpoint). Default is false.
vnet_cidr_block str
vnet_name str
vnet_resource_group str
worker_cidr str
worker_subnet_name str
worker_subnet_security_group_name str
region This property is required. String
resourceGroup This property is required. String
sshKey This property is required. String
Public SSH key to be used for the cluster nodes.
subscriptionId This property is required. String
controlPlaneCidr String
controlPlaneSubnetName String
controlPlaneSubnetSecurityGroupName String
privateCluster Boolean
Whether to create a private cluster(API endpoint). Default is false.
vnetCidrBlock String
vnetName String
vnetResourceGroup String
workerCidr String
workerSubnetName String
workerSubnetSecurityGroupName String

ClusterAksClusterProfile
, ClusterAksClusterProfileArgs

Id This property is required. string
The ID of the cluster profile.
Packs List<ClusterAksClusterProfilePack>
For packs of type spectro, helm, and manifest, at least one pack must be specified.
Variables Dictionary<string, string>
A map of cluster profile variables, specified as key-value pairs. For example: priority = "5".
Id This property is required. string
The ID of the cluster profile.
Packs []ClusterAksClusterProfilePack
For packs of type spectro, helm, and manifest, at least one pack must be specified.
Variables map[string]string
A map of cluster profile variables, specified as key-value pairs. For example: priority = "5".
id This property is required. String
The ID of the cluster profile.
packs List<ClusterAksClusterProfilePack>
For packs of type spectro, helm, and manifest, at least one pack must be specified.
variables Map<String,String>
A map of cluster profile variables, specified as key-value pairs. For example: priority = "5".
id This property is required. string
The ID of the cluster profile.
packs ClusterAksClusterProfilePack[]
For packs of type spectro, helm, and manifest, at least one pack must be specified.
variables {[key: string]: string}
A map of cluster profile variables, specified as key-value pairs. For example: priority = "5".
id This property is required. str
The ID of the cluster profile.
packs Sequence[ClusterAksClusterProfilePack]
For packs of type spectro, helm, and manifest, at least one pack must be specified.
variables Mapping[str, str]
A map of cluster profile variables, specified as key-value pairs. For example: priority = "5".
id This property is required. String
The ID of the cluster profile.
packs List<Property Map>
For packs of type spectro, helm, and manifest, at least one pack must be specified.
variables Map<String>
A map of cluster profile variables, specified as key-value pairs. For example: priority = "5".

ClusterAksClusterProfilePack
, ClusterAksClusterProfilePackArgs

Name This property is required. string
The name of the pack. The name must be unique within the cluster profile.
Manifests List<ClusterAksClusterProfilePackManifest>
RegistryUid 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 or helm.
Type string
The type of the pack. Allowed values are spectro, manifest, helm, or oci. The default value is spectro. If using an OCI registry for pack, set the type to oci.
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 is spectro and for helm 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 This property is required. string
The name of the pack. The name must be unique within the cluster profile.
Manifests []ClusterAksClusterProfilePackManifest
RegistryUid 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 or helm.
Type string
The type of the pack. Allowed values are spectro, manifest, helm, or oci. The default value is spectro. If using an OCI registry for pack, set the type to oci.
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 is spectro and for helm 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 This property is required. String
The name of the pack. The name must be unique within the cluster profile.
manifests List<ClusterAksClusterProfilePackManifest>
registryUid 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 or helm.
type String
The type of the pack. Allowed values are spectro, manifest, helm, or oci. The default value is spectro. If using an OCI registry for pack, set the type to oci.
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 is spectro and for helm 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 This property is required. string
The name of the pack. The name must be unique within the cluster profile.
manifests ClusterAksClusterProfilePackManifest[]
registryUid 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 or helm.
type string
The type of the pack. Allowed values are spectro, manifest, helm, or oci. The default value is spectro. If using an OCI registry for pack, set the type to oci.
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 is spectro and for helm 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 This property is required. str
The name of the pack. The name must be unique within the cluster profile.
manifests Sequence[ClusterAksClusterProfilePackManifest]
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 or helm.
type str
The type of the pack. Allowed values are spectro, manifest, helm, or oci. The default value is spectro. If using an OCI registry for pack, set the type to oci.
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 is spectro and for helm 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 This property is required. String
The name of the pack. The name must be unique within the cluster profile.
manifests List<Property Map>
registryUid 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 or helm.
type String
The type of the pack. Allowed values are spectro, manifest, helm, or oci. The default value is spectro. If using an OCI registry for pack, set the type to oci.
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 is spectro and for helm 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.

ClusterAksClusterProfilePackManifest
, ClusterAksClusterProfilePackManifestArgs

Content This property is required. string
The content of the manifest. The content is the YAML content of the manifest.
Name This property is required. string
The name of the manifest. The name must be unique within the pack.
Uid string
Content This property is required. string
The content of the manifest. The content is the YAML content of the manifest.
Name This property is required. string
The name of the manifest. The name must be unique within the pack.
Uid string
content This property is required. String
The content of the manifest. The content is the YAML content of the manifest.
name This property is required. String
The name of the manifest. The name must be unique within the pack.
uid String
content This property is required. string
The content of the manifest. The content is the YAML content of the manifest.
name This property is required. string
The name of the manifest. The name must be unique within the pack.
uid string
content This property is required. str
The content of the manifest. The content is the YAML content of the manifest.
name This property is required. str
The name of the manifest. The name must be unique within the pack.
uid str
content This property is required. String
The content of the manifest. The content is the YAML content of the manifest.
name This property is required. String
The name of the manifest. The name must be unique within the pack.
uid String

ClusterAksClusterRbacBinding
, ClusterAksClusterRbacBindingArgs

Type This property is required. string
The type of the RBAC binding. Can be one of the following values: RoleBinding, or ClusterRoleBinding.
Namespace string
The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
Role Dictionary<string, string>
The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
Subjects List<ClusterAksClusterRbacBindingSubject>
Type This property is required. string
The type of the RBAC binding. Can be one of the following values: RoleBinding, or ClusterRoleBinding.
Namespace string
The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
Role map[string]string
The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
Subjects []ClusterAksClusterRbacBindingSubject
type This property is required. String
The type of the RBAC binding. Can be one of the following values: RoleBinding, or ClusterRoleBinding.
namespace String
The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
role Map<String,String>
The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
subjects List<ClusterAksClusterRbacBindingSubject>
type This property is required. string
The type of the RBAC binding. Can be one of the following values: RoleBinding, or ClusterRoleBinding.
namespace string
The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
role {[key: string]: string}
The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
subjects ClusterAksClusterRbacBindingSubject[]
type This property is required. str
The type of the RBAC binding. Can be one of the following values: RoleBinding, or ClusterRoleBinding.
namespace str
The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
role Mapping[str, str]
The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
subjects Sequence[ClusterAksClusterRbacBindingSubject]
type This property is required. String
The type of the RBAC binding. Can be one of the following values: RoleBinding, or ClusterRoleBinding.
namespace String
The Kubernetes namespace of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
role Map<String>
The role of the RBAC binding. Required if 'type' is set to 'RoleBinding'.
subjects List<Property Map>

ClusterAksClusterRbacBindingSubject
, ClusterAksClusterRbacBindingSubjectArgs

Name This property is required. string
The name of the subject. Required if 'type' is set to 'User' or 'Group'.
Type This property is required. string
The type of the subject. Can be one of the following values: User, Group, or ServiceAccount.
Namespace string
The Kubernetes namespace of the subject. Required if 'type' is set to 'ServiceAccount'.
Name This property is required. string
The name of the subject. Required if 'type' is set to 'User' or 'Group'.
Type This property is required. string
The type of the subject. Can be one of the following values: User, Group, or ServiceAccount.
Namespace string
The Kubernetes namespace of the subject. Required if 'type' is set to 'ServiceAccount'.
name This property is required. String
The name of the subject. Required if 'type' is set to 'User' or 'Group'.
type This property is required. String
The type of the subject. Can be one of the following values: User, Group, or ServiceAccount.
namespace String
The Kubernetes namespace of the subject. Required if 'type' is set to 'ServiceAccount'.
name This property is required. string
The name of the subject. Required if 'type' is set to 'User' or 'Group'.
type This property is required. string
The type of the subject. Can be one of the following values: User, Group, or ServiceAccount.
namespace string
The Kubernetes namespace of the subject. Required if 'type' is set to 'ServiceAccount'.
name This property is required. str
The name of the subject. Required if 'type' is set to 'User' or 'Group'.
type This property is required. str
The type of the subject. Can be one of the following values: User, Group, or ServiceAccount.
namespace str
The Kubernetes namespace of the subject. Required if 'type' is set to 'ServiceAccount'.
name This property is required. String
The name of the subject. Required if 'type' is set to 'User' or 'Group'.
type This property is required. String
The type of the subject. Can be one of the following values: User, Group, or ServiceAccount.
namespace String
The Kubernetes namespace of the subject. Required if 'type' is set to 'ServiceAccount'.

ClusterAksHostConfig
, ClusterAksHostConfigArgs

ExternalTrafficPolicy string
The external traffic policy for the cluster.
HostEndpointType string
The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
IngressHost string
The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
LoadBalancerSourceRanges string
The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
ExternalTrafficPolicy string
The external traffic policy for the cluster.
HostEndpointType string
The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
IngressHost string
The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
LoadBalancerSourceRanges string
The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
externalTrafficPolicy String
The external traffic policy for the cluster.
hostEndpointType String
The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
ingressHost String
The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
loadBalancerSourceRanges String
The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
externalTrafficPolicy string
The external traffic policy for the cluster.
hostEndpointType string
The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
ingressHost string
The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
loadBalancerSourceRanges string
The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
external_traffic_policy str
The external traffic policy for the cluster.
host_endpoint_type str
The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
ingress_host str
The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
load_balancer_source_ranges str
The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.
externalTrafficPolicy String
The external traffic policy for the cluster.
hostEndpointType String
The type of endpoint for the cluster. Can be either 'Ingress' or 'LoadBalancer'. The default is 'Ingress'.
ingressHost String
The host for the Ingress endpoint. Required if 'hostendpointtype' is set to 'Ingress'.
loadBalancerSourceRanges String
The source ranges for the load balancer. Required if 'hostendpointtype' is set to 'LoadBalancer'.

ClusterAksLocationConfig
, ClusterAksLocationConfigArgs

CountryCode This property is required. string
CountryName This property is required. string
Latitude This property is required. double
Longitude This property is required. double
RegionCode This property is required. string
RegionName This property is required. string
CountryCode This property is required. string
CountryName This property is required. string
Latitude This property is required. float64
Longitude This property is required. float64
RegionCode This property is required. string
RegionName This property is required. string
countryCode This property is required. String
countryName This property is required. String
latitude This property is required. Double
longitude This property is required. Double
regionCode This property is required. String
regionName This property is required. String
countryCode This property is required. string
countryName This property is required. string
latitude This property is required. number
longitude This property is required. number
regionCode This property is required. string
regionName This property is required. string
country_code This property is required. str
country_name This property is required. str
latitude This property is required. float
longitude This property is required. float
region_code This property is required. str
region_name This property is required. str
countryCode This property is required. String
countryName This property is required. String
latitude This property is required. Number
longitude This property is required. Number
regionCode This property is required. String
regionName This property is required. String

ClusterAksMachinePool
, ClusterAksMachinePoolArgs

Count This property is required. double
Number of nodes in the machine pool.
DiskSizeGb This property is required. double
InstanceType This property is required. string
IsSystemNodePool This property is required. bool
Name This property is required. string
StorageAccountType This property is required. string
AdditionalLabels Dictionary<string, string>
Max double
Maximum number of nodes in the machine pool. This is used for autoscaling the machine pool.
Min double
Minimum number of nodes in the machine pool. This is used for autoscaling the machine pool.
Nodes List<ClusterAksMachinePoolNode>
Taints List<ClusterAksMachinePoolTaint>
UpdateStrategy string
Update strategy for the machine pool. Valid values are RollingUpdateScaleOut and RollingUpdateScaleIn.
Count This property is required. float64
Number of nodes in the machine pool.
DiskSizeGb This property is required. float64
InstanceType This property is required. string
IsSystemNodePool This property is required. bool
Name This property is required. string
StorageAccountType This property is required. string
AdditionalLabels map[string]string
Max float64
Maximum number of nodes in the machine pool. This is used for autoscaling the machine pool.
Min float64
Minimum number of nodes in the machine pool. This is used for autoscaling the machine pool.
Nodes []ClusterAksMachinePoolNode
Taints []ClusterAksMachinePoolTaint
UpdateStrategy string
Update strategy for the machine pool. Valid values are RollingUpdateScaleOut and RollingUpdateScaleIn.
count This property is required. Double
Number of nodes in the machine pool.
diskSizeGb This property is required. Double
instanceType This property is required. String
isSystemNodePool This property is required. Boolean
name This property is required. String
storageAccountType This property is required. String
additionalLabels Map<String,String>
max Double
Maximum number of nodes in the machine pool. This is used for autoscaling the machine pool.
min Double
Minimum number of nodes in the machine pool. This is used for autoscaling the machine pool.
nodes List<ClusterAksMachinePoolNode>
taints List<ClusterAksMachinePoolTaint>
updateStrategy String
Update strategy for the machine pool. Valid values are RollingUpdateScaleOut and RollingUpdateScaleIn.
count This property is required. number
Number of nodes in the machine pool.
diskSizeGb This property is required. number
instanceType This property is required. string
isSystemNodePool This property is required. boolean
name This property is required. string
storageAccountType This property is required. string
additionalLabels {[key: string]: string}
max number
Maximum number of nodes in the machine pool. This is used for autoscaling the machine pool.
min number
Minimum number of nodes in the machine pool. This is used for autoscaling the machine pool.
nodes ClusterAksMachinePoolNode[]
taints ClusterAksMachinePoolTaint[]
updateStrategy string
Update strategy for the machine pool. Valid values are RollingUpdateScaleOut and RollingUpdateScaleIn.
count This property is required. float
Number of nodes in the machine pool.
disk_size_gb This property is required. float
instance_type This property is required. str
is_system_node_pool This property is required. bool
name This property is required. str
storage_account_type This property is required. str
additional_labels Mapping[str, str]
max float
Maximum number of nodes in the machine pool. This is used for autoscaling the machine pool.
min float
Minimum number of nodes in the machine pool. This is used for autoscaling the machine pool.
nodes Sequence[ClusterAksMachinePoolNode]
taints Sequence[ClusterAksMachinePoolTaint]
update_strategy str
Update strategy for the machine pool. Valid values are RollingUpdateScaleOut and RollingUpdateScaleIn.
count This property is required. Number
Number of nodes in the machine pool.
diskSizeGb This property is required. Number
instanceType This property is required. String
isSystemNodePool This property is required. Boolean
name This property is required. String
storageAccountType This property is required. String
additionalLabels Map<String>
max Number
Maximum number of nodes in the machine pool. This is used for autoscaling the machine pool.
min Number
Minimum number of nodes in the machine pool. This is used for autoscaling the machine pool.
nodes List<Property Map>
taints List<Property Map>
updateStrategy String
Update strategy for the machine pool. Valid values are RollingUpdateScaleOut and RollingUpdateScaleIn.

ClusterAksMachinePoolNode
, ClusterAksMachinePoolNodeArgs

Action This property is required. string
The action to perform on the node. Valid values are: cordon, uncordon.
NodeId This property is required. string
The node_id of the node, For example i-07f899a33dee624f7
Action This property is required. string
The action to perform on the node. Valid values are: cordon, uncordon.
NodeId This property is required. string
The node_id of the node, For example i-07f899a33dee624f7
action This property is required. String
The action to perform on the node. Valid values are: cordon, uncordon.
nodeId This property is required. String
The node_id of the node, For example i-07f899a33dee624f7
action This property is required. string
The action to perform on the node. Valid values are: cordon, uncordon.
nodeId This property is required. string
The node_id of the node, For example i-07f899a33dee624f7
action This property is required. str
The action to perform on the node. Valid values are: cordon, uncordon.
node_id This property is required. str
The node_id of the node, For example i-07f899a33dee624f7
action This property is required. String
The action to perform on the node. Valid values are: cordon, uncordon.
nodeId This property is required. String
The node_id of the node, For example i-07f899a33dee624f7

ClusterAksMachinePoolTaint
, ClusterAksMachinePoolTaintArgs

Effect This property is required. string
The effect of the taint. Allowed values are: NoSchedule, PreferNoSchedule or NoExecute.
Key This property is required. string
The key of the taint.
Value This property is required. string
The value of the taint.
Effect This property is required. string
The effect of the taint. Allowed values are: NoSchedule, PreferNoSchedule or NoExecute.
Key This property is required. string
The key of the taint.
Value This property is required. string
The value of the taint.
effect This property is required. String
The effect of the taint. Allowed values are: NoSchedule, PreferNoSchedule or NoExecute.
key This property is required. String
The key of the taint.
value This property is required. String
The value of the taint.
effect This property is required. string
The effect of the taint. Allowed values are: NoSchedule, PreferNoSchedule or NoExecute.
key This property is required. string
The key of the taint.
value This property is required. string
The value of the taint.
effect This property is required. str
The effect of the taint. Allowed values are: NoSchedule, PreferNoSchedule or NoExecute.
key This property is required. str
The key of the taint.
value This property is required. str
The value of the taint.
effect This property is required. String
The effect of the taint. Allowed values are: NoSchedule, PreferNoSchedule or NoExecute.
key This property is required. String
The key of the taint.
value This property is required. String
The value of the taint.

ClusterAksNamespace
, ClusterAksNamespaceArgs

Name This property is required. string
Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
ResourceAllocation This property is required. Dictionary<string, string>
Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example, {cpu_cores: '2', memory_MiB: '2048'}
ImagesBlacklists List<string>
List of images to disallow for the namespace. For example, ['nginx:latest', 'redis:latest']
Name This property is required. string
Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
ResourceAllocation This property is required. map[string]string
Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example, {cpu_cores: '2', memory_MiB: '2048'}
ImagesBlacklists []string
List of images to disallow for the namespace. For example, ['nginx:latest', 'redis:latest']
name This property is required. String
Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
resourceAllocation This property is required. Map<String,String>
Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example, {cpu_cores: '2', memory_MiB: '2048'}
imagesBlacklists List<String>
List of images to disallow for the namespace. For example, ['nginx:latest', 'redis:latest']
name This property is required. string
Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
resourceAllocation This property is required. {[key: string]: string}
Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example, {cpu_cores: '2', memory_MiB: '2048'}
imagesBlacklists string[]
List of images to disallow for the namespace. For example, ['nginx:latest', 'redis:latest']
name This property is required. str
Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
resource_allocation This property is required. Mapping[str, str]
Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example, {cpu_cores: '2', memory_MiB: '2048'}
images_blacklists Sequence[str]
List of images to disallow for the namespace. For example, ['nginx:latest', 'redis:latest']
name This property is required. String
Name of the namespace. This is the name of the Kubernetes namespace in the cluster.
resourceAllocation This property is required. Map<String>
Resource allocation for the namespace. This is a map containing the resource type and the resource value. For example, {cpu_cores: '2', memory_MiB: '2048'}
imagesBlacklists List<String>
List of images to disallow for the namespace. For example, ['nginx:latest', 'redis:latest']

ClusterAksScanPolicy
, ClusterAksScanPolicyArgs

ConfigurationScanSchedule This property is required. string
The schedule for configuration scan.
ConformanceScanSchedule This property is required. string
The schedule for conformance scan.
PenetrationScanSchedule This property is required. string
The schedule for penetration scan.
ConfigurationScanSchedule This property is required. string
The schedule for configuration scan.
ConformanceScanSchedule This property is required. string
The schedule for conformance scan.
PenetrationScanSchedule This property is required. string
The schedule for penetration scan.
configurationScanSchedule This property is required. String
The schedule for configuration scan.
conformanceScanSchedule This property is required. String
The schedule for conformance scan.
penetrationScanSchedule This property is required. String
The schedule for penetration scan.
configurationScanSchedule This property is required. string
The schedule for configuration scan.
conformanceScanSchedule This property is required. string
The schedule for conformance scan.
penetrationScanSchedule This property is required. string
The schedule for penetration scan.
configuration_scan_schedule This property is required. str
The schedule for configuration scan.
conformance_scan_schedule This property is required. str
The schedule for conformance scan.
penetration_scan_schedule This property is required. str
The schedule for penetration scan.
configurationScanSchedule This property is required. String
The schedule for configuration scan.
conformanceScanSchedule This property is required. String
The schedule for conformance scan.
penetrationScanSchedule This property is required. String
The schedule for penetration scan.

ClusterAksTimeouts
, ClusterAksTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Import

Using pulumi import, import the cluster using the id colon separated with context. For example:

$ pulumi import spectrocloud:index/clusterAks:ClusterAks example example_id:project
Copy

Refer to the Import section to learn more.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
spectrocloud spectrocloud/terraform-provider-spectrocloud
License
Notes
This Pulumi package is based on the spectrocloud Terraform Provider.