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

netapp-cloudmanager.Volume

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

    Create Volume Resource

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

    Constructor syntax

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

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           provider_volume_type: Optional[str] = None,
           unit: Optional[str] = None,
           client_id: Optional[str] = None,
           size: Optional[float] = None,
           name: Optional[str] = None,
           connector_ip: Optional[str] = None,
           enable_compression: Optional[bool] = None,
           enable_deduplication: Optional[bool] = None,
           enable_thin_provisioning: Optional[bool] = None,
           export_policy_ips: Optional[Sequence[str]] = None,
           export_policy_name: Optional[str] = None,
           export_policy_nfs_versions: Optional[Sequence[str]] = None,
           export_policy_rule_access_control: Optional[str] = None,
           export_policy_rule_super_user: Optional[bool] = None,
           export_policy_type: Optional[str] = None,
           igroups: Optional[Sequence[str]] = None,
           initiators: Optional[Sequence[VolumeInitiatorArgs]] = None,
           iops: Optional[float] = None,
           aggregate_name: Optional[str] = None,
           os_name: Optional[str] = None,
           permission: Optional[str] = None,
           deployment_mode: Optional[str] = None,
           share_name: Optional[str] = None,
           comment: Optional[str] = None,
           snapshot_policies: Optional[Sequence[VolumeSnapshotPolicyArgs]] = None,
           snapshot_policy_name: Optional[str] = None,
           svm_name: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           tenant_id: Optional[str] = None,
           throughput: Optional[float] = None,
           tiering_policy: Optional[str] = None,
           capacity_tier: Optional[str] = None,
           users: Optional[Sequence[str]] = None,
           volume_id: Optional[str] = None,
           volume_protocol: Optional[str] = None,
           working_environment_id: Optional[str] = None,
           working_environment_name: Optional[str] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)

    type: netapp-cloudmanager:Volume
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 VolumeArgs
    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 VolumeArgs
    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 VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    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 volumeResource = new NetappCloudmanager.Volume("volumeResource", new()
{
    ProviderVolumeType = "string",
    Unit = "string",
    ClientId = "string",
    Size = 0,
    Name = "string",
    ConnectorIp = "string",
    EnableCompression = false,
    EnableDeduplication = false,
    EnableThinProvisioning = false,
    ExportPolicyIps = new[]
    {
        "string",
    },
    ExportPolicyName = "string",
    ExportPolicyNfsVersions = new[]
    {
        "string",
    },
    ExportPolicyRuleAccessControl = "string",
    ExportPolicyRuleSuperUser = false,
    ExportPolicyType = "string",
    Igroups = new[]
    {
        "string",
    },
    Initiators = new[]
    {
        new NetappCloudmanager.Inputs.VolumeInitiatorArgs
        {
            Alias = "string",
            Iqn = "string",
        },
    },
    Iops = 0,
    AggregateName = "string",
    OsName = "string",
    Permission = "string",
    DeploymentMode = "string",
    ShareName = "string",
    Comment = "string",
    SnapshotPolicies = new[]
    {
        new NetappCloudmanager.Inputs.VolumeSnapshotPolicyArgs
        {
            Schedules = new[]
            {
                new NetappCloudmanager.Inputs.VolumeSnapshotPolicyScheduleArgs
                {
                    Retention = 0,
                    ScheduleType = "string",
                },
            },
        },
    },
    SnapshotPolicyName = "string",
    SvmName = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TenantId = "string",
    Throughput = 0,
    TieringPolicy = "string",
    CapacityTier = "string",
    Users = new[]
    {
        "string",
    },
    VolumeId = "string",
    VolumeProtocol = "string",
    WorkingEnvironmentId = "string",
    WorkingEnvironmentName = "string",
});

    example, err := netappcloudmanager.NewVolume(ctx, "volumeResource", &netappcloudmanager.VolumeArgs{
	ProviderVolumeType:     pulumi.String("string"),
	Unit:                   pulumi.String("string"),
	ClientId:               pulumi.String("string"),
	Size:                   pulumi.Float64(0),
	Name:                   pulumi.String("string"),
	ConnectorIp:            pulumi.String("string"),
	EnableCompression:      pulumi.Bool(false),
	EnableDeduplication:    pulumi.Bool(false),
	EnableThinProvisioning: pulumi.Bool(false),
	ExportPolicyIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExportPolicyName: pulumi.String("string"),
	ExportPolicyNfsVersions: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExportPolicyRuleAccessControl: pulumi.String("string"),
	ExportPolicyRuleSuperUser:     pulumi.Bool(false),
	ExportPolicyType:              pulumi.String("string"),
	Igroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Initiators: netappcloudmanager.VolumeInitiatorArray{
		&netappcloudmanager.VolumeInitiatorArgs{
			Alias: pulumi.String("string"),
			Iqn:   pulumi.String("string"),
		},
	},
	Iops:           pulumi.Float64(0),
	AggregateName:  pulumi.String("string"),
	OsName:         pulumi.String("string"),
	Permission:     pulumi.String("string"),
	DeploymentMode: pulumi.String("string"),
	ShareName:      pulumi.String("string"),
	Comment:        pulumi.String("string"),
	SnapshotPolicies: netappcloudmanager.VolumeSnapshotPolicyArray{
		&netappcloudmanager.VolumeSnapshotPolicyArgs{
			Schedules: netappcloudmanager.VolumeSnapshotPolicyScheduleArray{
				&netappcloudmanager.VolumeSnapshotPolicyScheduleArgs{
					Retention:    pulumi.Float64(0),
					ScheduleType: pulumi.String("string"),
				},
			},
		},
	},
	SnapshotPolicyName: pulumi.String("string"),
	SvmName:            pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TenantId:      pulumi.String("string"),
	Throughput:    pulumi.Float64(0),
	TieringPolicy: pulumi.String("string"),
	CapacityTier:  pulumi.String("string"),
	Users: pulumi.StringArray{
		pulumi.String("string"),
	},
	VolumeId:               pulumi.String("string"),
	VolumeProtocol:         pulumi.String("string"),
	WorkingEnvironmentId:   pulumi.String("string"),
	WorkingEnvironmentName: pulumi.String("string"),
})

    var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .providerVolumeType("string")
    .unit("string")
    .clientId("string")
    .size(0)
    .name("string")
    .connectorIp("string")
    .enableCompression(false)
    .enableDeduplication(false)
    .enableThinProvisioning(false)
    .exportPolicyIps("string")
    .exportPolicyName("string")
    .exportPolicyNfsVersions("string")
    .exportPolicyRuleAccessControl("string")
    .exportPolicyRuleSuperUser(false)
    .exportPolicyType("string")
    .igroups("string")
    .initiators(VolumeInitiatorArgs.builder()
        .alias("string")
        .iqn("string")
        .build())
    .iops(0)
    .aggregateName("string")
    .osName("string")
    .permission("string")
    .deploymentMode("string")
    .shareName("string")
    .comment("string")
    .snapshotPolicies(VolumeSnapshotPolicyArgs.builder()
        .schedules(VolumeSnapshotPolicyScheduleArgs.builder()
            .retention(0)
            .scheduleType("string")
            .build())
        .build())
    .snapshotPolicyName("string")
    .svmName("string")
    .tags(Map.of("string", "string"))
    .tenantId("string")
    .throughput(0)
    .tieringPolicy("string")
    .capacityTier("string")
    .users("string")
    .volumeId("string")
    .volumeProtocol("string")
    .workingEnvironmentId("string")
    .workingEnvironmentName("string")
    .build());

    volume_resource = netapp_cloudmanager.Volume("volumeResource",
    provider_volume_type="string",
    unit="string",
    client_id="string",
    size=0,
    name="string",
    connector_ip="string",
    enable_compression=False,
    enable_deduplication=False,
    enable_thin_provisioning=False,
    export_policy_ips=["string"],
    export_policy_name="string",
    export_policy_nfs_versions=["string"],
    export_policy_rule_access_control="string",
    export_policy_rule_super_user=False,
    export_policy_type="string",
    igroups=["string"],
    initiators=[{
        "alias": "string",
        "iqn": "string",
    }],
    iops=0,
    aggregate_name="string",
    os_name="string",
    permission="string",
    deployment_mode="string",
    share_name="string",
    comment="string",
    snapshot_policies=[{
        "schedules": [{
            "retention": 0,
            "schedule_type": "string",
        }],
    }],
    snapshot_policy_name="string",
    svm_name="string",
    tags={
        "string": "string",
    },
    tenant_id="string",
    throughput=0,
    tiering_policy="string",
    capacity_tier="string",
    users=["string"],
    volume_id="string",
    volume_protocol="string",
    working_environment_id="string",
    working_environment_name="string")

    const volumeResource = new netapp_cloudmanager.Volume("volumeResource", {
    providerVolumeType: "string",
    unit: "string",
    clientId: "string",
    size: 0,
    name: "string",
    connectorIp: "string",
    enableCompression: false,
    enableDeduplication: false,
    enableThinProvisioning: false,
    exportPolicyIps: ["string"],
    exportPolicyName: "string",
    exportPolicyNfsVersions: ["string"],
    exportPolicyRuleAccessControl: "string",
    exportPolicyRuleSuperUser: false,
    exportPolicyType: "string",
    igroups: ["string"],
    initiators: [{
        alias: "string",
        iqn: "string",
    }],
    iops: 0,
    aggregateName: "string",
    osName: "string",
    permission: "string",
    deploymentMode: "string",
    shareName: "string",
    comment: "string",
    snapshotPolicies: [{
        schedules: [{
            retention: 0,
            scheduleType: "string",
        }],
    }],
    snapshotPolicyName: "string",
    svmName: "string",
    tags: {
        string: "string",
    },
    tenantId: "string",
    throughput: 0,
    tieringPolicy: "string",
    capacityTier: "string",
    users: ["string"],
    volumeId: "string",
    volumeProtocol: "string",
    workingEnvironmentId: "string",
    workingEnvironmentName: "string",
});

    type: netapp-cloudmanager:Volume
properties:
    aggregateName: string
    capacityTier: string
    clientId: string
    comment: string
    connectorIp: string
    deploymentMode: string
    enableCompression: false
    enableDeduplication: false
    enableThinProvisioning: false
    exportPolicyIps:
        - string
    exportPolicyName: string
    exportPolicyNfsVersions:
        - string
    exportPolicyRuleAccessControl: string
    exportPolicyRuleSuperUser: false
    exportPolicyType: string
    igroups:
        - string
    initiators:
        - alias: string
          iqn: string
    iops: 0
    name: string
    osName: string
    permission: string
    providerVolumeType: string
    shareName: string
    size: 0
    snapshotPolicies:
        - schedules:
            - retention: 0
              scheduleType: string
    snapshotPolicyName: string
    svmName: string
    tags:
        string: string
    tenantId: string
    throughput: 0
    tieringPolicy: string
    unit: string
    users:
        - string
    volumeId: string
    volumeProtocol: string
    workingEnvironmentId: string
    workingEnvironmentName: string

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

    ClientId string
    ProviderVolumeType string
    Size double
    Unit string
    AggregateName string
    CapacityTier string
    Comment string
    ConnectorIp string
    DeploymentMode string
    EnableCompression bool
    EnableDeduplication bool
    EnableThinProvisioning bool
    ExportPolicyIps List<string>
    ExportPolicyName string
    ExportPolicyNfsVersions List<string>
    ExportPolicyRuleAccessControl string
    ExportPolicyRuleSuperUser bool
    ExportPolicyType string
    Igroups List<string>
    Initiators List<Pulumi.NetappCloudmanager.Inputs.VolumeInitiator>
    Iops double
    Name string
    OsName string
    Permission string
    ShareName string
    SnapshotPolicies List<Pulumi.NetappCloudmanager.Inputs.VolumeSnapshotPolicy>
    SnapshotPolicyName string
    SvmName string
    Tags Dictionary<string, string>
    TenantId string
    Throughput double
    TieringPolicy string
    Users List<string>
    VolumeId string
    VolumeProtocol string
    WorkingEnvironmentId string
    WorkingEnvironmentName string
    clientId String
    providerVolumeType String
    size Double
    unit String
    aggregateName String
    capacityTier String
    comment String
    connectorIp String
    deploymentMode String
    enableCompression Boolean
    enableDeduplication Boolean
    enableThinProvisioning Boolean
    exportPolicyIps List<String>
    exportPolicyName String
    exportPolicyNfsVersions List<String>
    exportPolicyRuleAccessControl String
    exportPolicyRuleSuperUser Boolean
    exportPolicyType String
    igroups List<String>
    initiators List<VolumeInitiator>
    iops Double
    name String
    osName String
    permission String
    shareName String
    snapshotPolicies List<VolumeSnapshotPolicy>
    snapshotPolicyName String
    svmName String
    tags Map<String,String>
    tenantId String
    throughput Double
    tieringPolicy String
    users List<String>
    volumeId String
    volumeProtocol String
    workingEnvironmentId String
    workingEnvironmentName String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Volume 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 Volume Resource

    Get an existing Volume 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?: VolumeState, opts?: CustomResourceOptions): Volume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregate_name: Optional[str] = None,
        capacity_tier: Optional[str] = None,
        client_id: Optional[str] = None,
        comment: Optional[str] = None,
        connector_ip: Optional[str] = None,
        deployment_mode: Optional[str] = None,
        enable_compression: Optional[bool] = None,
        enable_deduplication: Optional[bool] = None,
        enable_thin_provisioning: Optional[bool] = None,
        export_policy_ips: Optional[Sequence[str]] = None,
        export_policy_name: Optional[str] = None,
        export_policy_nfs_versions: Optional[Sequence[str]] = None,
        export_policy_rule_access_control: Optional[str] = None,
        export_policy_rule_super_user: Optional[bool] = None,
        export_policy_type: Optional[str] = None,
        igroups: Optional[Sequence[str]] = None,
        initiators: Optional[Sequence[VolumeInitiatorArgs]] = None,
        iops: Optional[float] = None,
        name: Optional[str] = None,
        os_name: Optional[str] = None,
        permission: Optional[str] = None,
        provider_volume_type: Optional[str] = None,
        share_name: Optional[str] = None,
        size: Optional[float] = None,
        snapshot_policies: Optional[Sequence[VolumeSnapshotPolicyArgs]] = None,
        snapshot_policy_name: Optional[str] = None,
        svm_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tenant_id: Optional[str] = None,
        throughput: Optional[float] = None,
        tiering_policy: Optional[str] = None,
        unit: Optional[str] = None,
        users: Optional[Sequence[str]] = None,
        volume_id: Optional[str] = None,
        volume_protocol: Optional[str] = None,
        working_environment_id: Optional[str] = None,
        working_environment_name: Optional[str] = None) -> Volume
    func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
    public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
    public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
    resources:  _:    type: netapp-cloudmanager:Volume    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:
    AggregateName string
    CapacityTier string
    ClientId string
    Comment string
    ConnectorIp string
    DeploymentMode string
    EnableCompression bool
    EnableDeduplication bool
    EnableThinProvisioning bool
    ExportPolicyIps List<string>
    ExportPolicyName string
    ExportPolicyNfsVersions List<string>
    ExportPolicyRuleAccessControl string
    ExportPolicyRuleSuperUser bool
    ExportPolicyType string
    Igroups List<string>
    Initiators List<Pulumi.NetappCloudmanager.Inputs.VolumeInitiator>
    Iops double
    Name string
    OsName string
    Permission string
    ProviderVolumeType string
    ShareName string
    Size double
    SnapshotPolicies List<Pulumi.NetappCloudmanager.Inputs.VolumeSnapshotPolicy>
    SnapshotPolicyName string
    SvmName string
    Tags Dictionary<string, string>
    TenantId string
    Throughput double
    TieringPolicy string
    Unit string
    Users List<string>
    VolumeId string
    VolumeProtocol string
    WorkingEnvironmentId string
    WorkingEnvironmentName string
    aggregateName String
    capacityTier String
    clientId String
    comment String
    connectorIp String
    deploymentMode String
    enableCompression Boolean
    enableDeduplication Boolean
    enableThinProvisioning Boolean
    exportPolicyIps List<String>
    exportPolicyName String
    exportPolicyNfsVersions List<String>
    exportPolicyRuleAccessControl String
    exportPolicyRuleSuperUser Boolean
    exportPolicyType String
    igroups List<String>
    initiators List<VolumeInitiator>
    iops Double
    name String
    osName String
    permission String
    providerVolumeType String
    shareName String
    size Double
    snapshotPolicies List<VolumeSnapshotPolicy>
    snapshotPolicyName String
    svmName String
    tags Map<String,String>
    tenantId String
    throughput Double
    tieringPolicy String
    unit String
    users List<String>
    volumeId String
    volumeProtocol String
    workingEnvironmentId String
    workingEnvironmentName String

    Supporting Types

    VolumeInitiator, VolumeInitiatorArgs

    Alias string
    Iqn string
    Alias string
    Iqn string
    alias String
    iqn String
    alias string
    iqn string
    alias str
    iqn str
    alias String
    iqn String

    VolumeSnapshotPolicy, VolumeSnapshotPolicyArgs

    VolumeSnapshotPolicySchedule, VolumeSnapshotPolicyScheduleArgs

    Retention double
    ScheduleType string
    Retention float64
    ScheduleType string
    retention Double
    scheduleType String
    retention number
    scheduleType string
    retention Number
    scheduleType String

    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