Package software.amazon.awscdk.cfnpropertymixins.services.fsx

Class CfnVolumePropsMixin.OntapConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnVolumePropsMixin.OntapConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnVolumePropsMixin.OntapConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnVolumePropsMixin.OntapConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnVolumePropsMixin.OntapConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnVolumePropsMixin.OntapConfigurationProperty

An implementation for CfnVolumePropsMixin.OntapConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnVolumePropsMixin.OntapConfigurationProperty

CfnVolumePropsMixin.OntapConfigurationProperty.Builder, CfnVolumePropsMixin.OntapConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnVolumePropsMixin.OntapConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnVolumePropsMixin.OntapConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAggregateConfiguration()	Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
final String	getCopyTagsToBackups()	A boolean flag indicating whether tags for the volume should be copied to backups.
final String	getJunctionPath()	Specifies the location in the SVM's namespace where the volume is mounted.
final String	getOntapVolumeType()	Specifies the type of volume you are creating.
final String	getSecurityStyle()	Specifies the security style for the volume.
final String	getSizeInBytes()	Specifies the configured size of the volume, in bytes.
final String	getSizeInMegabytes()	Use SizeInBytes instead.
final Object	getSnaplockConfiguration()	The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
final String	getSnapshotPolicy()	Specifies the snapshot policy for the volume.
final String	getStorageEfficiencyEnabled()	Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
final String	getStorageVirtualMachineId()	Specifies the ONTAP SVM in which to create the volume.
final Object	getTieringPolicy()	Describes the data tiering policy for an ONTAP volume.
final String	getVolumeStyle()	Use to specify the style of an ONTAP volume.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnVolumePropsMixin.OntapConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnVolumePropsMixin.OntapConfigurationProperty.Builder.

Method Details

getAggregateConfiguration

public final Object getAggregateConfiguration()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.

Returns union: either IResolvable or CfnVolumePropsMixin.AggregateConfigurationProperty

Specified by:

getAggregateConfiguration in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-aggregateconfiguration

getCopyTagsToBackups

public final String getCopyTagsToBackups()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

A boolean flag indicating whether tags for the volume should be copied to backups.

This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

Specified by:

getCopyTagsToBackups in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-copytagstobackups

getJunctionPath

public final String getJunctionPath()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Specifies the location in the SVM's namespace where the volume is mounted.

This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3 .

Specified by:

getJunctionPath in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-junctionpath

getOntapVolumeType

public final String getOntapVolumeType()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Specifies the type of volume you are creating. Valid values are the following:.

• RW specifies a read/write volume. RW is the default.
• DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

Specified by:

getOntapVolumeType in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-ontapvolumetype

getSecurityStyle

public final String getSecurityStyle()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Specifies the security style for the volume.

If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:

• UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
• NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
• MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

For more information, see Volume security style in the FSx for ONTAP User Guide.

Specified by:

getSecurityStyle in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-securitystyle

getSizeInBytes

public final String getSizeInBytes()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Specifies the configured size of the volume, in bytes.

Specified by:

getSizeInBytes in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-sizeinbytes

getSizeInMegabytes

public final String getSizeInMegabytes()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Use SizeInBytes instead.

Specifies the size of the volume, in megabytes (MB), that you are creating.

Specified by:

getSizeInMegabytes in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-sizeinmegabytes

getSnaplockConfiguration

public final Object getSnaplockConfiguration()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

Returns union: either IResolvable or CfnVolumePropsMixin.SnaplockConfigurationProperty

Specified by:

getSnaplockConfiguration in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-snaplockconfiguration

getSnapshotPolicy

public final String getSnapshotPolicy()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:.

• default : This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
• default-1weekly : This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
• none : This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

Specified by:

getSnapshotPolicy in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-snapshotpolicy

getStorageEfficiencyEnabled

public final String getStorageEfficiencyEnabled()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

StorageEfficiencyEnabled is required when creating a RW volume ( OntapVolumeType set to RW ).

Specified by:

getStorageEfficiencyEnabled in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-storageefficiencyenabled

getStorageVirtualMachineId

public final String getStorageVirtualMachineId()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Specifies the ONTAP SVM in which to create the volume.

Specified by:

getStorageVirtualMachineId in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-storagevirtualmachineid

getTieringPolicy

public final Object getTieringPolicy()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Describes the data tiering policy for an ONTAP volume.

When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

• SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.
• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

Returns union: either IResolvable or CfnVolumePropsMixin.TieringPolicyProperty

Specified by:

getTieringPolicy in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-tieringpolicy

getVolumeStyle

public final String getVolumeStyle()

Description copied from interface: CfnVolumePropsMixin.OntapConfigurationProperty

Use to specify the style of an ONTAP volume.

FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

Specified by:

getVolumeStyle in interface CfnVolumePropsMixin.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html#cfn-fsx-volume-ontapconfiguration-volumestyle

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object