Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netapp-Cloudmanager Provider
  3. API Docs
  4. Aggregate
netapp-cloudmanager 25.3.0 published on Monday, Apr 14, 2025 by netapp
netapp/terraform-provider-netapp-cloudmanager

netapp-cloudmanager.Aggregate

Explore with Pulumi AI

netapp-cloudmanager logo
netapp-cloudmanager 25.3.0 published on Monday, Apr 14, 2025 by netapp
netapp/terraform-provider-netapp-cloudmanager

    Provides a netapp-cloudmanager_aggregate resource. This can be used to create a new aggregate on Cloud Volumes ONTAP. Requires existence of a Cloud Manager Connector and a Cloud Volumes ONTAP system.

    Example Usage

    S

    Create netapp-cloudmanager_aggregate:

    import * as pulumi from "@pulumi/pulumi";
import * as netapp_cloudmanager from "@pulumi/netapp-cloudmanager";

const cl_aggregate = new netapp_cloudmanager.Aggregate("cl-aggregate", {
    workingEnvironmentId: netapp_cloudmanager_cvo_gcp["cvo-gcp"].id,
    clientId: netapp_cloudmanager_connector_gcp["cm-gcp"].client_id,
    numberOfDisks: 1,
    providerVolumeType: "gp2",
}, {
    provider: netapp_cloudmanager,
});

    import pulumi
import pulumi_netapp_cloudmanager as netapp_cloudmanager

cl_aggregate = netapp_cloudmanager.Aggregate("cl-aggregate",
    working_environment_id=netapp_cloudmanager_cvo_gcp["cvo-gcp"]["id"],
    client_id=netapp_cloudmanager_connector_gcp["cm-gcp"]["client_id"],
    number_of_disks=1,
    provider_volume_type="gp2",
    opts = pulumi.ResourceOptions(provider=netapp_cloudmanager))

    package main

import (
	netappcloudmanager "github.com/pulumi/pulumi-terraform-provider/sdks/go/netapp-cloudmanager/v25/netapp-cloudmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netappcloudmanager.NewAggregate(ctx, "cl-aggregate", &netappcloudmanager.AggregateArgs{
			WorkingEnvironmentId: pulumi.Any(netapp_cloudmanager_cvo_gcp.CvoGcp.Id),
			ClientId:             pulumi.Any(netapp_cloudmanager_connector_gcp.CmGcp.Client_id),
			NumberOfDisks:        pulumi.Float64(1),
			ProviderVolumeType:   pulumi.String("gp2"),
		}, pulumi.Provider(netapp_cloudmanager))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using NetappCloudmanager = Pulumi.NetappCloudmanager;

return await Deployment.RunAsync(() => 
{
    var cl_aggregate = new NetappCloudmanager.Aggregate("cl-aggregate", new()
    {
        WorkingEnvironmentId = netapp_cloudmanager_cvo_gcp.Cvo_gcp.Id,
        ClientId = netapp_cloudmanager_connector_gcp.Cm_gcp.Client_id,
        NumberOfDisks = 1,
        ProviderVolumeType = "gp2",
    }, new CustomResourceOptions
    {
        Provider = netapp_cloudmanager,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netappcloudmanager.Aggregate;
import com.pulumi.netappcloudmanager.AggregateArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        var cl_aggregate = new Aggregate("cl-aggregate", AggregateArgs.builder()
            .workingEnvironmentId(netapp_cloudmanager_cvo_gcp.cvo-gcp().id())
            .clientId(netapp_cloudmanager_connector_gcp.cm-gcp().client_id())
            .numberOfDisks(1)
            .providerVolumeType("gp2")
            .build(), CustomResourceOptions.builder()
                .provider(netapp_cloudmanager)
                .build());

    }
}

    resources:
  cl-aggregate:
    type: netapp-cloudmanager:Aggregate
    properties:
      workingEnvironmentId: ${["netapp-cloudmanager_cvo_gcp"]"cvo-gcp"[%!s(MISSING)].id}
      #
      clientId: ${["netapp-cloudmanager_connector_gcp"]"cm-gcp"[%!s(MISSING)].client_id}
      #
      numberOfDisks: 1
      providerVolumeType: gp2
    options:
      provider: ${["netapp-cloudmanager"]}

    Create Aggregate Resource

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

    Constructor syntax

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

@overload
def Aggregate(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              client_id: Optional[str] = None,
              number_of_disks: Optional[float] = None,
              iops: Optional[float] = None,
              name: Optional[str] = None,
              deployment_mode: Optional[str] = None,
              disk_size_size: Optional[float] = None,
              disk_size_unit: Optional[str] = None,
              home_node: Optional[str] = None,
              aggregate_id: Optional[str] = None,
              connector_ip: Optional[str] = None,
              capacity_tier: Optional[str] = None,
              provider_volume_type: Optional[str] = None,
              tenant_id: Optional[str] = None,
              throughput: Optional[float] = None,
              working_environment_id: Optional[str] = None,
              working_environment_name: Optional[str] = None)
    func NewAggregate(ctx *Context, name string, args AggregateArgs, opts ...ResourceOption) (*Aggregate, error)
    public Aggregate(string name, AggregateArgs args, CustomResourceOptions? opts = null)
    public Aggregate(String name, AggregateArgs args)
public Aggregate(String name, AggregateArgs args, CustomResourceOptions options)

    type: netapp-cloudmanager:Aggregate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AggregateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AggregateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AggregateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AggregateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AggregateArgs
    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 aggregateResource = new NetappCloudmanager.Aggregate("aggregateResource", new()
{
    ClientId = "string",
    NumberOfDisks = 0,
    Iops = 0,
    Name = "string",
    DeploymentMode = "string",
    DiskSizeSize = 0,
    DiskSizeUnit = "string",
    HomeNode = "string",
    AggregateId = "string",
    ConnectorIp = "string",
    CapacityTier = "string",
    ProviderVolumeType = "string",
    TenantId = "string",
    Throughput = 0,
    WorkingEnvironmentId = "string",
    WorkingEnvironmentName = "string",
});

    example, err := netappcloudmanager.NewAggregate(ctx, "aggregateResource", &netappcloudmanager.AggregateArgs{
	ClientId:               pulumi.String("string"),
	NumberOfDisks:          pulumi.Float64(0),
	Iops:                   pulumi.Float64(0),
	Name:                   pulumi.String("string"),
	DeploymentMode:         pulumi.String("string"),
	DiskSizeSize:           pulumi.Float64(0),
	DiskSizeUnit:           pulumi.String("string"),
	HomeNode:               pulumi.String("string"),
	AggregateId:            pulumi.String("string"),
	ConnectorIp:            pulumi.String("string"),
	CapacityTier:           pulumi.String("string"),
	ProviderVolumeType:     pulumi.String("string"),
	TenantId:               pulumi.String("string"),
	Throughput:             pulumi.Float64(0),
	WorkingEnvironmentId:   pulumi.String("string"),
	WorkingEnvironmentName: pulumi.String("string"),
})

    var aggregateResource = new Aggregate("aggregateResource", AggregateArgs.builder()
    .clientId("string")
    .numberOfDisks(0)
    .iops(0)
    .name("string")
    .deploymentMode("string")
    .diskSizeSize(0)
    .diskSizeUnit("string")
    .homeNode("string")
    .aggregateId("string")
    .connectorIp("string")
    .capacityTier("string")
    .providerVolumeType("string")
    .tenantId("string")
    .throughput(0)
    .workingEnvironmentId("string")
    .workingEnvironmentName("string")
    .build());

    aggregate_resource = netapp_cloudmanager.Aggregate("aggregateResource",
    client_id="string",
    number_of_disks=0,
    iops=0,
    name="string",
    deployment_mode="string",
    disk_size_size=0,
    disk_size_unit="string",
    home_node="string",
    aggregate_id="string",
    connector_ip="string",
    capacity_tier="string",
    provider_volume_type="string",
    tenant_id="string",
    throughput=0,
    working_environment_id="string",
    working_environment_name="string")

    const aggregateResource = new netapp_cloudmanager.Aggregate("aggregateResource", {
    clientId: "string",
    numberOfDisks: 0,
    iops: 0,
    name: "string",
    deploymentMode: "string",
    diskSizeSize: 0,
    diskSizeUnit: "string",
    homeNode: "string",
    aggregateId: "string",
    connectorIp: "string",
    capacityTier: "string",
    providerVolumeType: "string",
    tenantId: "string",
    throughput: 0,
    workingEnvironmentId: "string",
    workingEnvironmentName: "string",
});

    type: netapp-cloudmanager:Aggregate
properties:
    aggregateId: string
    capacityTier: string
    clientId: string
    connectorIp: string
    deploymentMode: string
    diskSizeSize: 0
    diskSizeUnit: string
    homeNode: string
    iops: 0
    name: string
    numberOfDisks: 0
    providerVolumeType: string
    tenantId: string
    throughput: 0
    workingEnvironmentId: string
    workingEnvironmentName: string

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

    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    NumberOfDisks double
    The required number of disks in the new aggregate.
    AggregateId string
    will be the aggregate name.
    CapacityTier string
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    ConnectorIp string
    The IP of the connector, this is only required for 'Restricted' mode account.
    DeploymentMode string
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    DiskSizeSize double
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    DiskSizeUnit string
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    HomeNode string
    The home node that the new aggregate should belong to. The default is the first node.
    Iops double
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    Name string
    The name of the new aggregate.
    ProviderVolumeType string
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    TenantId string
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    Throughput double
    Required only when 'providerVolumeType' is 'gp3'.
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    NumberOfDisks float64
    The required number of disks in the new aggregate.
    AggregateId string
    will be the aggregate name.
    CapacityTier string
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    ConnectorIp string
    The IP of the connector, this is only required for 'Restricted' mode account.
    DeploymentMode string
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    DiskSizeSize float64
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    DiskSizeUnit string
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    HomeNode string
    The home node that the new aggregate should belong to. The default is the first node.
    Iops float64
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    Name string
    The name of the new aggregate.
    ProviderVolumeType string
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    TenantId string
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    Throughput float64
    Required only when 'providerVolumeType' is 'gp3'.
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    numberOfDisks Double
    The required number of disks in the new aggregate.
    aggregateId String
    will be the aggregate name.
    capacityTier String
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    connectorIp String
    The IP of the connector, this is only required for 'Restricted' mode account.
    deploymentMode String
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    diskSizeSize Double
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    diskSizeUnit String
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    homeNode String
    The home node that the new aggregate should belong to. The default is the first node.
    iops Double
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name String
    The name of the new aggregate.
    providerVolumeType String
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenantId String
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput Double
    Required only when 'providerVolumeType' is 'gp3'.
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    clientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    numberOfDisks number
    The required number of disks in the new aggregate.
    aggregateId string
    will be the aggregate name.
    capacityTier string
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    connectorIp string
    The IP of the connector, this is only required for 'Restricted' mode account.
    deploymentMode string
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    diskSizeSize number
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    diskSizeUnit string
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    homeNode string
    The home node that the new aggregate should belong to. The default is the first node.
    iops number
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name string
    The name of the new aggregate.
    providerVolumeType string
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenantId string
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput number
    Required only when 'providerVolumeType' is 'gp3'.
    workingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    client_id str
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    number_of_disks float
    The required number of disks in the new aggregate.
    aggregate_id str
    will be the aggregate name.
    capacity_tier str
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    connector_ip str
    The IP of the connector, this is only required for 'Restricted' mode account.
    deployment_mode str
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    disk_size_size float
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    disk_size_unit str
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    home_node str
    The home node that the new aggregate should belong to. The default is the first node.
    iops float
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name str
    The name of the new aggregate.
    provider_volume_type str
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenant_id str
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput float
    Required only when 'providerVolumeType' is 'gp3'.
    working_environment_id str
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    working_environment_name str
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    numberOfDisks Number
    The required number of disks in the new aggregate.
    aggregateId String
    will be the aggregate name.
    capacityTier String
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    connectorIp String
    The IP of the connector, this is only required for 'Restricted' mode account.
    deploymentMode String
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    diskSizeSize Number
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    diskSizeUnit String
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    homeNode String
    The home node that the new aggregate should belong to. The default is the first node.
    iops Number
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name String
    The name of the new aggregate.
    providerVolumeType String
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenantId String
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput Number
    Required only when 'providerVolumeType' is 'gp3'.
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Aggregate Resource

    Get an existing Aggregate 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?: AggregateState, opts?: CustomResourceOptions): Aggregate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregate_id: Optional[str] = None,
        capacity_tier: Optional[str] = None,
        client_id: Optional[str] = None,
        connector_ip: Optional[str] = None,
        deployment_mode: Optional[str] = None,
        disk_size_size: Optional[float] = None,
        disk_size_unit: Optional[str] = None,
        home_node: Optional[str] = None,
        iops: Optional[float] = None,
        name: Optional[str] = None,
        number_of_disks: Optional[float] = None,
        provider_volume_type: Optional[str] = None,
        tenant_id: Optional[str] = None,
        throughput: Optional[float] = None,
        working_environment_id: Optional[str] = None,
        working_environment_name: Optional[str] = None) -> Aggregate
    func GetAggregate(ctx *Context, name string, id IDInput, state *AggregateState, opts ...ResourceOption) (*Aggregate, error)
    public static Aggregate Get(string name, Input<string> id, AggregateState? state, CustomResourceOptions? opts = null)
    public static Aggregate get(String name, Output<String> id, AggregateState state, CustomResourceOptions options)
    resources:  _:    type: netapp-cloudmanager:Aggregate    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AggregateId string
    will be the aggregate name.
    CapacityTier string
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    ConnectorIp string
    The IP of the connector, this is only required for 'Restricted' mode account.
    DeploymentMode string
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    DiskSizeSize double
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    DiskSizeUnit string
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    HomeNode string
    The home node that the new aggregate should belong to. The default is the first node.
    Iops double
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    Name string
    The name of the new aggregate.
    NumberOfDisks double
    The required number of disks in the new aggregate.
    ProviderVolumeType string
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    TenantId string
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    Throughput double
    Required only when 'providerVolumeType' is 'gp3'.
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    AggregateId string
    will be the aggregate name.
    CapacityTier string
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    ClientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    ConnectorIp string
    The IP of the connector, this is only required for 'Restricted' mode account.
    DeploymentMode string
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    DiskSizeSize float64
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    DiskSizeUnit string
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    HomeNode string
    The home node that the new aggregate should belong to. The default is the first node.
    Iops float64
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    Name string
    The name of the new aggregate.
    NumberOfDisks float64
    The required number of disks in the new aggregate.
    ProviderVolumeType string
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    TenantId string
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    Throughput float64
    Required only when 'providerVolumeType' is 'gp3'.
    WorkingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    WorkingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    aggregateId String
    will be the aggregate name.
    capacityTier String
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    connectorIp String
    The IP of the connector, this is only required for 'Restricted' mode account.
    deploymentMode String
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    diskSizeSize Double
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    diskSizeUnit String
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    homeNode String
    The home node that the new aggregate should belong to. The default is the first node.
    iops Double
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name String
    The name of the new aggregate.
    numberOfDisks Double
    The required number of disks in the new aggregate.
    providerVolumeType String
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenantId String
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput Double
    Required only when 'providerVolumeType' is 'gp3'.
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    aggregateId string
    will be the aggregate name.
    capacityTier string
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    clientId string
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    connectorIp string
    The IP of the connector, this is only required for 'Restricted' mode account.
    deploymentMode string
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    diskSizeSize number
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    diskSizeUnit string
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    homeNode string
    The home node that the new aggregate should belong to. The default is the first node.
    iops number
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name string
    The name of the new aggregate.
    numberOfDisks number
    The required number of disks in the new aggregate.
    providerVolumeType string
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenantId string
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput number
    Required only when 'providerVolumeType' is 'gp3'.
    workingEnvironmentId string
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName string
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    aggregate_id str
    will be the aggregate name.
    capacity_tier str
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    client_id str
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    connector_ip str
    The IP of the connector, this is only required for 'Restricted' mode account.
    deployment_mode str
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    disk_size_size float
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    disk_size_unit str
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    home_node str
    The home node that the new aggregate should belong to. The default is the first node.
    iops float
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name str
    The name of the new aggregate.
    number_of_disks float
    The required number of disks in the new aggregate.
    provider_volume_type str
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenant_id str
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput float
    Required only when 'providerVolumeType' is 'gp3'.
    working_environment_id str
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    working_environment_name str
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.
    aggregateId String
    will be the aggregate name.
    capacityTier String
    The aggregate's capacity tier for tiering cold data to object storage: ['S3', 'Blob', 'cloudStorage']. The default values for each cloud provider are as follows: Amazon => 'S3', Azure => 'Blob', GCP => 'cloudStorage'. If NONE, the capacity tier won't be set on aggregate creation.
    clientId String
    The client ID of the Cloud Manager Connector. You can find the ID from a previous create Connector action as shown in the example, or from the Connector tab on https://console.bluexp.netapp.com/.
    connectorIp String
    The IP of the connector, this is only required for 'Restricted' mode account.
    deploymentMode String
    The mode of deployment to use for the working environment: ['Standard', 'Restricted']. The default is 'Standard'. To know more on deployment modes https://docs.netapp.com/us-en/bluexp-setup-admin/concept-modes.html/
    diskSizeSize Number
    The required size of the disks. The default is '1'. The max number depends on the provider_volume_type. Details in this document: AWS: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-aws.html#aggregate-limits] Azure: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-azure.html#aggregate-limits] GCP: [https://docs.netapp.com/us-en/cloud-volumes-ontap-relnotes/reference-limits-gcp.html#disk-and-tiering-limits]
    diskSizeUnit String
    The disk size unit ['GB' or 'TB']. The default is 'TB'
    homeNode String
    The home node that the new aggregate should belong to. The default is the first node.
    iops Number
    Provisioned IOPS. Needed only when 'providerVolumeType' is 'io1' or 'gp3'
    name String
    The name of the new aggregate.
    numberOfDisks Number
    The required number of disks in the new aggregate.
    providerVolumeType String
    The cloud provider volume type. For AWS: ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure: ['Premium_LRS','Standard_LRS','StandardSSD_LRS']. For GCP: ['pd-balanced', 'pd-ssd','pd-standard']
    tenantId String
    The NetApp tenant ID that the Connector will be associated with. This is required for the Restricted deployment mode. You can find the tenant ID in the Identity & Access Management in Settings, Organization tab of BlueXP at https://console.bluexp.netapp.com/.
    throughput Number
    Required only when 'providerVolumeType' is 'gp3'.
    workingEnvironmentId String
    The public ID of the working environment where the aggregate will be created. This argument is optional if working_environment_name is provided. You can find the ID from a previous create Cloud Volumes ONTAP action as shown in the example, or from the information page of the Cloud Volumes ONTAP working environment on https://console.bluexp.netapp.com/.
    workingEnvironmentName String
    The working environment name where the aggregate will be created. This argument will be ignored if working_environment_id is provided.

    Package Details

    Repository
    netapp-cloudmanager netapp/terraform-provider-netapp-cloudmanager
    License
    Notes
    This Pulumi package is based on the netapp-cloudmanager Terraform Provider.
    netapp-cloudmanager logo
    netapp-cloudmanager 25.3.0 published on Monday, Apr 14, 2025 by netapp
    netapp/terraform-provider-netapp-cloudmanager