@Stability(value=Stable) @Internal public static final class CfnFileSystemProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnFileSystemProps
CfnFileSystemPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnFileSystemProps.Builder, CfnFileSystemProps.Jsii$Proxy| Modifier | Constructor and 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.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getAvailabilityZoneName()
Used to create a file system that uses One Zone storage classes.
|
Object |
getBackupPolicy()
Use the `BackupPolicy` to turn automatic backups on or off for the file system.
|
Object |
getBypassPolicyLockoutSafetyCheck()
(Optional) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check.
|
Object |
getEncrypted()
A Boolean value that, if true, creates an encrypted file system.
|
Object |
getFileSystemPolicy()
The `FileSystemPolicy` for the EFS file system.
|
List<CfnFileSystem.ElasticFileSystemTagProperty> |
getFileSystemTags()
Use to create one or more tags associated with the file system.
|
String |
getKmsKeyId()
The ID of the AWS KMS key to be used to protect the encrypted file system.
|
Object |
getLifecyclePolicies()
An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object.
|
String |
getPerformanceMode()
The performance mode of the file system.
|
Number |
getProvisionedThroughputInMibps()
The throughput, measured in MiB/s, that you want to provision for a file system that you're creating.
|
String |
getThroughputMode()
Specifies the throughput mode for the file system, either `bursting` or `provisioned` .
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnFileSystemProps.Builder builder)
CfnFileSystemProps.Builder.public final String getAvailabilityZoneName()
CfnFileSystemProps
It specifies 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 storage classes, see Using EFS storage classes in the Amazon EFS User Guide .
One Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available.
getAvailabilityZoneName in interface CfnFileSystemPropspublic final Object getBackupPolicy()
CfnFileSystemPropsgetBackupPolicy in interface CfnFileSystemPropspublic final Object getBypassPolicyLockoutSafetyCheck()
CfnFileSystemProps
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 .
getBypassPolicyLockoutSafetyCheck in interface CfnFileSystemPropspublic final Object getEncrypted()
CfnFileSystemProps
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.
getEncrypted in interface CfnFileSystemPropspublic final Object getFileSystemPolicy()
CfnFileSystemPropsA 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 .
getFileSystemPolicy in interface CfnFileSystemPropspublic final List<CfnFileSystem.ElasticFileSystemTagProperty> getFileSystemTags()
CfnFileSystemProps
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 .
getFileSystemTags in interface CfnFileSystemPropspublic final String getKmsKeyId()
CfnFileSystemPropsThis 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:
1234abcd-12ab-34cd-56ef-1234567890ab .arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .alias/projectKey1 .arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .
If KmsKeyId is specified, the Encrypted parameter must be set to true.
getKmsKeyId in interface CfnFileSystemPropspublic final Object getLifecyclePolicies()
CfnFileSystemProps
A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:
Amazon EFS requires that each
LifecyclePolicyobject have only a single transition. This means that in a request body,LifecyclePoliciesneeds to be structured as an array ofLifecyclePolicyobjects, one object for each transition,TransitionToIA,TransitionToPrimaryStorageClass. See the example requests in the following section for more information.
getLifecyclePolicies in interface CfnFileSystemPropspublic final String getPerformanceMode()
CfnFileSystemProps
We recommend generalPurpose performance mode for most 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
maxIOmode is not supported on file systems using One Zone storage classes.
getPerformanceMode in interface CfnFileSystemPropspublic final Number getProvisionedThroughputInMibps()
CfnFileSystemProps
Valid values are 1-1024. Required if ThroughputMode is set to provisioned . The upper limit for throughput is 1024 MiB/s. To increase this limit, contact AWS Support . For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide .
getProvisionedThroughputInMibps in interface CfnFileSystemPropspublic final String getThroughputMode()
CfnFileSystemProps
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 throughput in Provisioned Throughput mode or change between the throughput modes, as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide .
Default is bursting .
getThroughputMode in interface CfnFileSystemProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.