Package com.hashicorp.cdktf.providers.google.netapp_volume

Interface NetappVolumeConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    NetappVolumeConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.012Z")
@Stability(Stable)
public interface NetappVolumeConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getCapacityGib

        @Stability(Stable)
@NotNull
String getCapacityGib()
        Capacity of the volume (in GiB).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#capacity_gib NetappVolume#capacity_gib}

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        Name of the pool location.

        Usually a region name, expect for some STANDARD service level pools which require a zone name. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#location NetappVolume#location}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The name of the volume. Needs to be unique per location.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#name NetappVolume#name}

      • getProtocols

        @Stability(Stable)
@NotNull
List<String> getProtocols()
        The protocol of the volume.

        Allowed combinations are '['NFSV3']', '['NFSV4']', '['SMB']', '['NFSV3', 'NFSV4']', '['SMB', 'NFSV3']' and '['SMB', 'NFSV4']'. Possible values: ["NFSV3", "NFSV4", "SMB"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#protocols NetappVolume#protocols}

      • getShareName

        @Stability(Stable)
@NotNull
String getShareName()
        Share name (SMB) or export path (NFS) of the volume. Needs to be unique per location.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#share_name NetappVolume#share_name}

      • getStoragePool

        @Stability(Stable)
@NotNull
String getStoragePool()
        Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#storage_pool NetappVolume#storage_pool}

      • getBackupConfig

        @Stability(Stable)
@Nullable
default NetappVolumeBackupConfig getBackupConfig()
        backup_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#backup_config NetappVolume#backup_config}

      • getDeletionPolicy

        @Stability(Stable)
@Nullable
default String getDeletionPolicy()
        Policy to determine if the volume should be deleted forcefully.

        Volumes may have nested snapshot resources. Deleting such a volume will fail. Setting this parameter to FORCE will delete volumes including nested snapshots. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#deletion_policy NetappVolume#deletion_policy}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        An optional description of this resource.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#description NetappVolume#description}

      • getExportPolicy

        @Stability(Stable)
@Nullable
default NetappVolumeExportPolicy getExportPolicy()
        export_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#export_policy NetappVolume#export_policy}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#id NetappVolume#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getKerberosEnabled

        @Stability(Stable)
@Nullable
default Object getKerberosEnabled()
        Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#kerberos_enabled NetappVolume#kerberos_enabled}

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        Labels as key value pairs. Example: '{ "owner": "Bob", "department": "finance", "purpose": "testing" }'.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#labels NetappVolume#labels}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#project NetappVolume#project}.

      • getRestoreParameters

        @Stability(Stable)
@Nullable
default NetappVolumeRestoreParameters getRestoreParameters()
        restore_parameters block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#restore_parameters NetappVolume#restore_parameters}

      • getRestrictedActions

        @Stability(Stable)
@Nullable
default List<String> getRestrictedActions()
        List of actions that are restricted on this volume. Possible values: ["DELETE"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#restricted_actions NetappVolume#restricted_actions}

      • getSecurityStyle

        @Stability(Stable)
@Nullable
default String getSecurityStyle()
        Security Style of the Volume.

        Use UNIX to use UNIX or NFSV4 ACLs for file permissions. Use NTFS to use NTFS ACLs for file permissions. Can only be set for volumes which use SMB together with NFS as protocol. Possible values: ["NTFS", "UNIX"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#security_style NetappVolume#security_style}

      • getSmbSettings

        @Stability(Stable)
@Nullable
default List<String> getSmbSettings()
        Settings for volumes with SMB access. Possible values: ["ENCRYPT_DATA", "BROWSABLE", "CHANGE_NOTIFY", "NON_BROWSABLE", "OPLOCKS", "SHOW_SNAPSHOT", "SHOW_PREVIOUS_VERSIONS", "ACCESS_BASED_ENUMERATION", "CONTINUOUSLY_AVAILABLE"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#smb_settings NetappVolume#smb_settings}

      • getSnapshotDirectory

        @Stability(Stable)
@Nullable
default Object getSnapshotDirectory()
        If enabled, a NFS volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots. Will enable "Previous Versions" support for SMB.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#snapshot_directory NetappVolume#snapshot_directory}

      • getSnapshotPolicy

        @Stability(Stable)
@Nullable
default NetappVolumeSnapshotPolicy getSnapshotPolicy()
        snapshot_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#snapshot_policy NetappVolume#snapshot_policy}

      • getTimeouts

        @Stability(Stable)
@Nullable
default NetappVolumeTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#timeouts NetappVolume#timeouts}

      • getUnixPermissions

        @Stability(Stable)
@Nullable
default String getUnixPermissions()
        Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/netapp_volume#unix_permissions NetappVolume#unix_permissions}