Package software.amazon.awscdk.services.efs

Class CfnFileSystemProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.efs.CfnFileSystemProps.Jsii$Proxy

All Implemented Interfaces:

CfnFileSystemProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnFileSystemProps

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

An implementation for CfnFileSystemProps

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.services.efs.CfnFileSystemProps

CfnFileSystemProps.Builder, CfnFileSystemProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnFileSystemProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnFileSystemProps.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 String	getAvailabilityZoneName()	For One Zone file systems, specify the AWS Availability Zone in which to create the file system.
final Object	getBackupPolicy()	Use the BackupPolicy to turn automatic backups on or off for the file system.
final Object	getBypassPolicyLockoutSafetyCheck()	(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.
final Object	getEncrypted()	A Boolean value that, if true, creates an encrypted file system.
final Object	getFileSystemPolicy()	The FileSystemPolicy for the EFS file system.
final Object	getFileSystemProtection()	Describes the protection on the file system.
final List<CfnFileSystem.ElasticFileSystemTagProperty>	getFileSystemTags()	Use to create one or more tags associated with the file system.
final String	getKmsKeyId()	The ID of the AWS KMS key to be used to protect the encrypted file system.
final Object	getLifecyclePolicies()	An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.
final String	getPerformanceMode()	The performance mode of the file system.
final Number	getProvisionedThroughputInMibps()	The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.
final Object	getReplicationConfiguration()	Describes the replication configuration for a specific file system.
final String	getThroughputMode()	Specifies the throughput mode for the file system.
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(CfnFileSystemProps.Builder builder)

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

Method Details

getAvailabilityZoneName

public final String getAvailabilityZoneName()

Description copied from interface: CfnFileSystemProps

For One Zone file systems, specify the AWS Availability Zone in which to create the file system.

Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see EFS file system types in the Amazon EFS User Guide .

One Zone file systems are not available in all Availability Zones in AWS Regions where Amazon EFS is available.

Specified by:

getAvailabilityZoneName in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-availabilityzonename

getBackupPolicy

public final Object getBackupPolicy()

Description copied from interface: CfnFileSystemProps

Use the BackupPolicy to turn automatic backups on or off for the file system.

Returns union: either IResolvable or CfnFileSystem.BackupPolicyProperty

Specified by:

getBackupPolicy in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-backuppolicy

getBypassPolicyLockoutSafetyCheck

public final Object getBypassPolicyLockoutSafetyCheck()

Description copied from interface: CfnFileSystemProps

(Optional) A boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check.

The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this file system. The default value is False .

Returns union: either Boolean or IResolvable

Specified by:

getBypassPolicyLockoutSafetyCheck in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-bypasspolicylockoutsafetycheck

getEncrypted

public final Object getEncrypted()

Description copied from interface: CfnFileSystemProps

A Boolean value that, if true, creates an encrypted file system.

When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key . If you don't specify a KMS key , then the default KMS key for Amazon EFS , /aws/elasticfilesystem , is used to protect the encrypted file system.

Returns union: either Boolean or IResolvable

Specified by:

getEncrypted in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-encrypted

getFileSystemPolicy

public final Object getFileSystemPolicy()

Description copied from interface: CfnFileSystemProps

The FileSystemPolicy for the EFS file system.

A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using IAM to control NFS access to Amazon EFS in the Amazon EFS User Guide .

Specified by:

getFileSystemPolicy in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystempolicy

getFileSystemProtection

public final Object getFileSystemProtection()

Description copied from interface: CfnFileSystemProps

Describes the protection on the file system.

Returns union: either IResolvable or CfnFileSystem.FileSystemProtectionProperty

Specified by:

getFileSystemProtection in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemprotection

getFileSystemTags

public final List<CfnFileSystem.ElasticFileSystemTagProperty> getFileSystemTags()

Description copied from interface: CfnFileSystemProps

Use to create one or more tags associated with the file system.

Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair. Each key must be unique. For more information, see Tagging AWS resources in the AWS General Reference Guide .

Specified by:

getFileSystemTags in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-filesystemtags

getKmsKeyId

public final String getKmsKeyId()

Description copied from interface: CfnFileSystemProps

The ID of the AWS KMS key to be used to protect the encrypted file system.

This parameter is only required if you want to use a nondefault KMS key . If this parameter is not specified, the default KMS key for Amazon EFS is used. This ID can be in one of the following formats:

• Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
• ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
• Key alias - A previously created display name for a key, for example alias/projectKey1 .
• Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .

If KmsKeyId is specified, the Encrypted parameter must be set to true.

Specified by:

getKmsKeyId in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-kmskeyid

getLifecyclePolicies

public final Object getLifecyclePolicies()

Description copied from interface: CfnFileSystemProps

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object.

A LifecycleConfiguration object informs Lifecycle management of the following:

• When to move files in the file system from primary storage to IA storage.
• When to move files in the file system from primary storage or IA storage to Archive storage.
• When to move files that are in IA or Archive storage to primary storage.

Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA , TransitionToArchive TransitionToPrimaryStorageClass . See the example requests in the following section for more information.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFileSystem.LifecyclePolicyProperty>

Specified by:

getLifecyclePolicies in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-lifecyclepolicies

getPerformanceMode

public final String getPerformanceMode()

Description copied from interface: CfnFileSystemProps

The performance mode of the file system.

We recommend generalPurpose performance mode for all file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The maxIO mode is not supported on One Zone file systems.

Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

Default is generalPurpose .

Specified by:

getPerformanceMode in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-performancemode

getProvisionedThroughputInMibps

public final Number getProvisionedThroughputInMibps()

Description copied from interface: CfnFileSystemProps

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating.

Required if ThroughputMode is set to provisioned . Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .

Specified by:

getProvisionedThroughputInMibps in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-provisionedthroughputinmibps

getReplicationConfiguration

public final Object getReplicationConfiguration()

Description copied from interface: CfnFileSystemProps

Describes the replication configuration for a specific file system.

Returns union: either IResolvable or CfnFileSystem.ReplicationConfigurationProperty

Specified by:

getReplicationConfiguration in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-replicationconfiguration

getThroughputMode

public final String getThroughputMode()

Description copied from interface: CfnFileSystemProps

Specifies the throughput mode for the file system.

The mode can be bursting , provisioned , or elastic . If you set ThroughputMode to provisioned , you must also set a value for ProvisionedThroughputInMibps . After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .

Default is bursting .

Specified by:

getThroughputMode in interface CfnFileSystemProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-efs-filesystem-throughputmode

$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