Package software.amazon.awscdk.services.efs

Class FileSystemProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.efs.FileSystemProps.Jsii$Proxy
All Implemented Interfaces:
FileSystemProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
FileSystemProps
@Stability(Stable) @Internal public static final class FileSystemProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements FileSystemProps
An implementation for FileSystemProps

  • 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(FileSystemProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the FileSystemProps.Builder.

  • Method Details

    • getVpc

      public final IVpc getVpc()
      Description copied from interface: FileSystemProps
      VPC to launch the file system in.
      Specified by:
      getVpc in interface FileSystemProps

    • getAllowAnonymousAccess

      public final Boolean getAllowAnonymousAccess()
      Description copied from interface: FileSystemProps
      Allow access from anonymous client that doesn't use IAM authentication.

      Default: false when using `grantRead`, `grantWrite`, `grantRootAccess` or set `@aws-cdk/aws-efs:denyAnonymousAccess` feature flag, otherwise true

      Specified by:
      getAllowAnonymousAccess in interface FileSystemProps

    • getEnableAutomaticBackups

      public final Boolean getEnableAutomaticBackups()
      Description copied from interface: FileSystemProps
      Whether to enable automatic backups for the file system.

      Default: false

      Specified by:
      getEnableAutomaticBackups in interface FileSystemProps

    • getEncrypted

      public final Boolean getEncrypted()
      Description copied from interface: FileSystemProps
      Defines if the data at rest in the file system is encrypted or not.

      Default: - If your application has the '@aws-cdk/aws-efs:defaultEncryptionAtRest' feature flag set, the default is true, otherwise, the default is false.

      Specified by:
      getEncrypted in interface FileSystemProps

    • getFileSystemName

      public final String getFileSystemName()
      Description copied from interface: FileSystemProps
      The file system's name.

      Default: - CDK generated name

      Specified by:
      getFileSystemName in interface FileSystemProps

    • getFileSystemPolicy

      public final PolicyDocument getFileSystemPolicy()
      Description copied from interface: FileSystemProps
      File system policy is an IAM resource policy used to control NFS access to an EFS file system.

      Default: none

      Specified by:
      getFileSystemPolicy in interface FileSystemProps

    • getKmsKey

      public final IKey getKmsKey()
      Description copied from interface: FileSystemProps
      The KMS key used for encryption.

      This is required to encrypt the data at rest if

      Default: - if 'encrypted' is true, the default key for EFS (/aws/elasticfilesystem) is used

      Specified by:
      getKmsKey in interface FileSystemProps

    • getLifecyclePolicy

      public final LifecyclePolicy getLifecyclePolicy()
      Description copied from interface: FileSystemProps
      A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

      Default: - None. EFS will not transition files to the IA storage class.

      Specified by:
      getLifecyclePolicy in interface FileSystemProps

    • getOneZone

      public final Boolean getOneZone()
      Description copied from interface: FileSystemProps
      Whether this is a One Zone file system.

      If enabled, performanceMode must be set to GENERAL_PURPOSE and vpcSubnets cannot be set.

      Default: false

      Specified by:
      getOneZone in interface FileSystemProps

    • getOutOfInfrequentAccessPolicy

      public final OutOfInfrequentAccessPolicy getOutOfInfrequentAccessPolicy()
      Description copied from interface: FileSystemProps
      A policy used by EFS lifecycle management to transition files from Infrequent Access (IA) storage class to primary storage class.

      Default: - None. EFS will not transition files from IA storage to primary storage.

      Specified by:
      getOutOfInfrequentAccessPolicy in interface FileSystemProps

    • getPerformanceMode

      public final PerformanceMode getPerformanceMode()
      Description copied from interface: FileSystemProps
      The performance mode that the file system will operate under.

      An Amazon EFS file system's performance mode can't be changed after the file system has been created. Updating this property will replace the file system.

      Default: PerformanceMode.GENERAL_PURPOSE

      Specified by:
      getPerformanceMode in interface FileSystemProps

    • getProvisionedThroughputPerSecond

      public final Size getProvisionedThroughputPerSecond()
      Description copied from interface: FileSystemProps
      Provisioned throughput for the file system.

      This is a required property if the throughput mode is set to PROVISIONED. Must be at least 1MiB/s.

      Default: - none, errors out

      Specified by:
      getProvisionedThroughputPerSecond in interface FileSystemProps

    • getRemovalPolicy

      public final RemovalPolicy getRemovalPolicy()
      Description copied from interface: FileSystemProps
      The removal policy to apply to the file system.

      Default: RemovalPolicy.RETAIN

      Specified by:
      getRemovalPolicy in interface FileSystemProps

    • getReplicationOverwriteProtection

      public final ReplicationOverwriteProtection getReplicationOverwriteProtection()
      Description copied from interface: FileSystemProps
      Whether to enable the filesystem's replication overwrite protection or not.

      Set false if you want to create a read-only filesystem for use as a replication destination.

      Default: ReplicationOverwriteProtection.ENABLED

      Specified by:
      getReplicationOverwriteProtection in interface FileSystemProps
      See Also:

    • getSecurityGroup

      public final ISecurityGroup getSecurityGroup()
      Description copied from interface: FileSystemProps
      Security Group to assign to this file system.

      Default: - creates new security group which allows all outbound traffic

      Specified by:
      getSecurityGroup in interface FileSystemProps

    • getThroughputMode

      public final ThroughputMode getThroughputMode()
      Description copied from interface: FileSystemProps
      Enum to mention the throughput mode of the file system.

      Default: ThroughputMode.BURSTING

      Specified by:
      getThroughputMode in interface FileSystemProps

    • getTransitionToArchivePolicy

      public final LifecyclePolicy getTransitionToArchivePolicy()
      Description copied from interface: FileSystemProps
      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage.

      Metadata operations such as listing the contents of a directory don't count as file access events.

      Default: - None. EFS will not transition files to Archive storage class.

      Specified by:
      getTransitionToArchivePolicy in interface FileSystemProps

    • getVpcSubnets

      public final SubnetSelection getVpcSubnets()
      Description copied from interface: FileSystemProps
      Which subnets to place the mount target in the VPC.

      Default: - the Vpc default strategy if not specified

      Specified by:
      getVpcSubnets in interface FileSystemProps

    • $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