Package software.amazon.awscdk.services.efs

Interface FileSystemAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileSystemAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:01.569Z")
@Stability(Stable)
public interface FileSystemAttributes
extends software.amazon.jsii.JsiiSerializable

Properties that describe an existing EFS file system.

Example:

 import software.amazon.awscdk.services.iam.*;
 IFileSystem importedFileSystem = FileSystem.fromFileSystemAttributes(this, "existingFS", FileSystemAttributes.builder()
         .fileSystemId("fs-12345678") // You can also use fileSystemArn instead of fileSystemId.
         .securityGroup(SecurityGroup.fromSecurityGroupId(this, "SG", "sg-123456789", SecurityGroupImportOptions.builder()
                 .allowAllOutbound(false)
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FileSystemAttributes.Builder	A builder for FileSystemAttributes
static final class	FileSystemAttributes.Jsii$Proxy	An implementation for FileSystemAttributes

Method Summary

Modifier and Type	Method	Description
static FileSystemAttributes.Builder	builder()
default String	getFileSystemArn()	The File System's Arn.
default String	getFileSystemId()	The File System's ID.
ISecurityGroup	getSecurityGroup()	The security group of the file system.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSecurityGroup

@Stability(Stable)
@NotNull
ISecurityGroup getSecurityGroup()

The security group of the file system.

getFileSystemArn

@Stability(Stable)
@Nullable
default String getFileSystemArn()

The File System's Arn.

Default: - determined based on fileSystemId

getFileSystemId

@Stability(Stable)
@Nullable
default String getFileSystemId()

The File System's ID.

Default: - determined based on fileSystemArn

builder

@Stability(Stable)
static FileSystemAttributes.Builder builder()

Returns:

a FileSystemAttributes.Builder of FileSystemAttributes