awsefs

package
v1.128.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 14, 2021 License: Apache-2.0 Imports: 9 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AccessPoint_IsConstruct 

func AccessPoint_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func AccessPoint_IsResource 

func AccessPoint_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func CfnAccessPoint_CFN_RESOURCE_TYPE_NAME 

func CfnAccessPoint_CFN_RESOURCE_TYPE_NAME() *string

func CfnAccessPoint_IsCfnElement 

func CfnAccessPoint_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnAccessPoint_IsCfnResource 

func CfnAccessPoint_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnAccessPoint_IsConstruct 

func CfnAccessPoint_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnFileSystem_CFN_RESOURCE_TYPE_NAME 

func CfnFileSystem_CFN_RESOURCE_TYPE_NAME() *string

func CfnFileSystem_IsCfnElement 

func CfnFileSystem_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnFileSystem_IsCfnResource 

func CfnFileSystem_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnFileSystem_IsConstruct 

func CfnFileSystem_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnMountTarget_CFN_RESOURCE_TYPE_NAME 

func CfnMountTarget_CFN_RESOURCE_TYPE_NAME() *string

func CfnMountTarget_IsCfnElement 

func CfnMountTarget_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnMountTarget_IsCfnResource 

func CfnMountTarget_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnMountTarget_IsConstruct 

func CfnMountTarget_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func FileSystem_DEFAULT_PORT 

func FileSystem_DEFAULT_PORT() *float64

func FileSystem_IsConstruct 

func FileSystem_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func FileSystem_IsResource 

func FileSystem_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewAccessPoint_Override 

func NewAccessPoint_Override(a AccessPoint, scope constructs.Construct, id *string, props *AccessPointProps)

Experimental.

func NewCfnAccessPoint_Override 

func NewCfnAccessPoint_Override(c CfnAccessPoint, scope awscdk.Construct, id *string, props *CfnAccessPointProps)

Create a new `AWS::EFS::AccessPoint`.

func NewCfnFileSystem_Override 

func NewCfnFileSystem_Override(c CfnFileSystem, scope awscdk.Construct, id *string, props *CfnFileSystemProps)

Create a new `AWS::EFS::FileSystem`.

func NewCfnMountTarget_Override 

func NewCfnMountTarget_Override(c CfnMountTarget, scope awscdk.Construct, id *string, props *CfnMountTargetProps)

Create a new `AWS::EFS::MountTarget`.

func NewFileSystem_Override 

func NewFileSystem_Override(f FileSystem, scope constructs.Construct, id *string, props *FileSystemProps)

Constructor for creating a new EFS FileSystem. Experimental.

Types

type AccessPoint 

type AccessPoint interface {
	awscdk.Resource
	IAccessPoint
	AccessPointArn() *string
	AccessPointId() *string
	Env() *awscdk.ResourceEnvironment
	FileSystem() IFileSystem
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

Represents the AccessPoint. Experimental.

func NewAccessPoint 

func NewAccessPoint(scope constructs.Construct, id *string, props *AccessPointProps) AccessPoint

Experimental.

type AccessPointAttributes 

type AccessPointAttributes struct {
	// The ARN of the AccessPoint One of this, or {@link accessPointId} is required.
	// Experimental.
	AccessPointArn *string `json:"accessPointArn"`
	// The ID of the AccessPoint One of this, or {@link accessPointArn} is required.
	// Experimental.
	AccessPointId *string `json:"accessPointId"`
	// The EFS file system.
	// Experimental.
	FileSystem IFileSystem `json:"fileSystem"`
}

Attributes that can be specified when importing an AccessPoint. Experimental.

type AccessPointOptions 

type AccessPointOptions struct {
	// Specifies the POSIX IDs and permissions to apply when creating the access point's root directory.
	//
	// If the
	// root directory specified by `path` does not exist, EFS creates the root directory and applies the
	// permissions specified here. If the specified `path` does not exist, you must specify `createAcl`.
	// Experimental.
	CreateAcl *Acl `json:"createAcl"`
	// Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.
	// Experimental.
	Path *string `json:"path"`
	// The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.
	//
	// Specify this to enforce a user identity using an access point.
	// See: - [Enforcing a User Identity Using an Access Point](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)
	//
	// Experimental.
	PosixUser *PosixUser `json:"posixUser"`
}

Options to create an AccessPoint. Experimental.

type AccessPointProps 

type AccessPointProps struct {
	// Specifies the POSIX IDs and permissions to apply when creating the access point's root directory.
	//
	// If the
	// root directory specified by `path` does not exist, EFS creates the root directory and applies the
	// permissions specified here. If the specified `path` does not exist, you must specify `createAcl`.
	// Experimental.
	CreateAcl *Acl `json:"createAcl"`
	// Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system.
	// Experimental.
	Path *string `json:"path"`
	// The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.
	//
	// Specify this to enforce a user identity using an access point.
	// See: - [Enforcing a User Identity Using an Access Point](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)
	//
	// Experimental.
	PosixUser *PosixUser `json:"posixUser"`
	// The efs filesystem.
	// Experimental.
	FileSystem IFileSystem `json:"fileSystem"`
}

Properties for the AccessPoint. Experimental.

type Acl 

type Acl struct {
	// Specifies the POSIX group ID to apply to the RootDirectory.
	//
	// Accepts values from 0 to 2^32 (4294967295).
	// Experimental.
	OwnerGid *string `json:"ownerGid"`
	// Specifies the POSIX user ID to apply to the RootDirectory.
	//
	// Accepts values from 0 to 2^32 (4294967295).
	// Experimental.
	OwnerUid *string `json:"ownerUid"`
	// Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.
	// Experimental.
	Permissions *string `json:"permissions"`
}

Permissions as POSIX ACL. Experimental.

type CfnAccessPoint 

type CfnAccessPoint interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccessPointTags() interface{}
	SetAccessPointTags(val interface{})
	AttrAccessPointId() *string
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClientToken() *string
	SetClientToken(val *string)
	CreationStack() *[]*string
	FileSystemId() *string
	SetFileSystemId(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	PosixUser() interface{}
	SetPosixUser(val interface{})
	Ref() *string
	RootDirectory() interface{}
	SetRootDirectory(val interface{})
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::EFS::AccessPoint`.

func NewCfnAccessPoint 

func NewCfnAccessPoint(scope awscdk.Construct, id *string, props *CfnAccessPointProps) CfnAccessPoint

Create a new `AWS::EFS::AccessPoint`.

type CfnAccessPointProps 

type CfnAccessPointProps struct {
	// `AWS::EFS::AccessPoint.FileSystemId`.
	FileSystemId *string `json:"fileSystemId"`
	// `AWS::EFS::AccessPoint.AccessPointTags`.
	AccessPointTags interface{} `json:"accessPointTags"`
	// `AWS::EFS::AccessPoint.ClientToken`.
	ClientToken *string `json:"clientToken"`
	// `AWS::EFS::AccessPoint.PosixUser`.
	PosixUser interface{} `json:"posixUser"`
	// `AWS::EFS::AccessPoint.RootDirectory`.
	RootDirectory interface{} `json:"rootDirectory"`
}

Properties for defining a `AWS::EFS::AccessPoint`.

type CfnAccessPoint_AccessPointTagProperty 

type CfnAccessPoint_AccessPointTagProperty struct {
	// `CfnAccessPoint.AccessPointTagProperty.Key`.
	Key *string `json:"key"`
	// `CfnAccessPoint.AccessPointTagProperty.Value`.
	Value *string `json:"value"`
}

type CfnAccessPoint_CreationInfoProperty 

type CfnAccessPoint_CreationInfoProperty struct {
	// `CfnAccessPoint.CreationInfoProperty.OwnerGid`.
	OwnerGid *string `json:"ownerGid"`
	// `CfnAccessPoint.CreationInfoProperty.OwnerUid`.
	OwnerUid *string `json:"ownerUid"`
	// `CfnAccessPoint.CreationInfoProperty.Permissions`.
	Permissions *string `json:"permissions"`
}

type CfnAccessPoint_PosixUserProperty 

type CfnAccessPoint_PosixUserProperty struct {
	// `CfnAccessPoint.PosixUserProperty.Gid`.
	Gid *string `json:"gid"`
	// `CfnAccessPoint.PosixUserProperty.Uid`.
	Uid *string `json:"uid"`
	// `CfnAccessPoint.PosixUserProperty.SecondaryGids`.
	SecondaryGids *[]*string `json:"secondaryGids"`
}

type CfnAccessPoint_RootDirectoryProperty 

type CfnAccessPoint_RootDirectoryProperty struct {
	// `CfnAccessPoint.RootDirectoryProperty.CreationInfo`.
	CreationInfo interface{} `json:"creationInfo"`
	// `CfnAccessPoint.RootDirectoryProperty.Path`.
	Path *string `json:"path"`
}

type CfnFileSystem 

type CfnFileSystem interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrFileSystemId() *string
	AvailabilityZoneName() *string
	SetAvailabilityZoneName(val *string)
	BackupPolicy() interface{}
	SetBackupPolicy(val interface{})
	BypassPolicyLockoutSafetyCheck() interface{}
	SetBypassPolicyLockoutSafetyCheck(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Encrypted() interface{}
	SetEncrypted(val interface{})
	FileSystemPolicy() interface{}
	SetFileSystemPolicy(val interface{})
	KmsKeyId() *string
	SetKmsKeyId(val *string)
	LifecyclePolicies() interface{}
	SetLifecyclePolicies(val interface{})
	LogicalId() *string
	Node() awscdk.ConstructNode
	PerformanceMode() *string
	SetPerformanceMode(val *string)
	ProvisionedThroughputInMibps() *float64
	SetProvisionedThroughputInMibps(val *float64)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	ThroughputMode() *string
	SetThroughputMode(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::EFS::FileSystem`.

func NewCfnFileSystem 

func NewCfnFileSystem(scope awscdk.Construct, id *string, props *CfnFileSystemProps) CfnFileSystem

Create a new `AWS::EFS::FileSystem`.

type CfnFileSystemProps 

type CfnFileSystemProps struct {
	// `AWS::EFS::FileSystem.AvailabilityZoneName`.
	AvailabilityZoneName *string `json:"availabilityZoneName"`
	// `AWS::EFS::FileSystem.BackupPolicy`.
	BackupPolicy interface{} `json:"backupPolicy"`
	// `AWS::EFS::FileSystem.BypassPolicyLockoutSafetyCheck`.
	BypassPolicyLockoutSafetyCheck interface{} `json:"bypassPolicyLockoutSafetyCheck"`
	// `AWS::EFS::FileSystem.Encrypted`.
	Encrypted interface{} `json:"encrypted"`
	// `AWS::EFS::FileSystem.FileSystemPolicy`.
	FileSystemPolicy interface{} `json:"fileSystemPolicy"`
	// `AWS::EFS::FileSystem.FileSystemTags`.
	FileSystemTags *[]*CfnFileSystem_ElasticFileSystemTagProperty `json:"fileSystemTags"`
	// `AWS::EFS::FileSystem.KmsKeyId`.
	KmsKeyId *string `json:"kmsKeyId"`
	// `AWS::EFS::FileSystem.LifecyclePolicies`.
	LifecyclePolicies interface{} `json:"lifecyclePolicies"`
	// `AWS::EFS::FileSystem.PerformanceMode`.
	PerformanceMode *string `json:"performanceMode"`
	// `AWS::EFS::FileSystem.ProvisionedThroughputInMibps`.
	ProvisionedThroughputInMibps *float64 `json:"provisionedThroughputInMibps"`
	// `AWS::EFS::FileSystem.ThroughputMode`.
	ThroughputMode *string `json:"throughputMode"`
}

Properties for defining a `AWS::EFS::FileSystem`.

type CfnFileSystem_BackupPolicyProperty 

type CfnFileSystem_BackupPolicyProperty struct {
	// `CfnFileSystem.BackupPolicyProperty.Status`.
	Status *string `json:"status"`
}

type CfnFileSystem_ElasticFileSystemTagProperty 

type CfnFileSystem_ElasticFileSystemTagProperty struct {
	// `CfnFileSystem.ElasticFileSystemTagProperty.Key`.
	Key *string `json:"key"`
	// `CfnFileSystem.ElasticFileSystemTagProperty.Value`.
	Value *string `json:"value"`
}

type CfnFileSystem_LifecyclePolicyProperty 

type CfnFileSystem_LifecyclePolicyProperty struct {
	// `CfnFileSystem.LifecyclePolicyProperty.TransitionToIA`.
	TransitionToIa *string `json:"transitionToIa"`
	// `CfnFileSystem.LifecyclePolicyProperty.TransitionToPrimaryStorageClass`.
	TransitionToPrimaryStorageClass *string `json:"transitionToPrimaryStorageClass"`
}

type CfnMountTarget 

type CfnMountTarget interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrId() *string
	AttrIpAddress() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	FileSystemId() *string
	SetFileSystemId(val *string)
	IpAddress() *string
	SetIpAddress(val *string)
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	SecurityGroups() *[]*string
	SetSecurityGroups(val *[]*string)
	Stack() awscdk.Stack
	SubnetId() *string
	SetSubnetId(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::EFS::MountTarget`.

func NewCfnMountTarget 

func NewCfnMountTarget(scope awscdk.Construct, id *string, props *CfnMountTargetProps) CfnMountTarget

Create a new `AWS::EFS::MountTarget`.

type CfnMountTargetProps 

type CfnMountTargetProps struct {
	// `AWS::EFS::MountTarget.FileSystemId`.
	FileSystemId *string `json:"fileSystemId"`
	// `AWS::EFS::MountTarget.SecurityGroups`.
	SecurityGroups *[]*string `json:"securityGroups"`
	// `AWS::EFS::MountTarget.SubnetId`.
	SubnetId *string `json:"subnetId"`
	// `AWS::EFS::MountTarget.IpAddress`.
	IpAddress *string `json:"ipAddress"`
}

Properties for defining a `AWS::EFS::MountTarget`.

type FileSystem 

type FileSystem interface {
	awscdk.Resource
	IFileSystem
	Connections() awsec2.Connections
	Env() *awscdk.ResourceEnvironment
	FileSystemArn() *string
	FileSystemId() *string
	MountTargetsAvailable() awscdk.IDependable
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	AddAccessPoint(id *string, accessPointOptions *AccessPointOptions) AccessPoint
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

The Elastic File System implementation of IFileSystem.

It creates a new, empty file system in Amazon Elastic File System (Amazon EFS). It also creates mount target (AWS::EFS::MountTarget) implicitly to mount the EFS file system on an Amazon Elastic Compute Cloud (Amazon EC2) instance or another resource. See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html

Experimental.

func NewFileSystem 

func NewFileSystem(scope constructs.Construct, id *string, props *FileSystemProps) FileSystem

Constructor for creating a new EFS FileSystem. Experimental.

type FileSystemAttributes 

type FileSystemAttributes struct {
	// The security group of the file system.
	// Experimental.
	SecurityGroup awsec2.ISecurityGroup `json:"securityGroup"`
	// The File System's Arn.
	// Experimental.
	FileSystemArn *string `json:"fileSystemArn"`
	// The File System's ID.
	// Experimental.
	FileSystemId *string `json:"fileSystemId"`
}

Properties that describe an existing EFS file system. Experimental.

type FileSystemProps 

type FileSystemProps struct {
	// VPC to launch the file system in.
	// Experimental.
	Vpc awsec2.IVpc `json:"vpc"`
	// Whether to enable automatic backups for the file system.
	// Experimental.
	EnableAutomaticBackups *bool `json:"enableAutomaticBackups"`
	// Defines if the data at rest in the file system is encrypted or not.
	// Experimental.
	Encrypted *bool `json:"encrypted"`
	// The file system's name.
	// Experimental.
	FileSystemName *string `json:"fileSystemName"`
	// The KMS key used for encryption.
	//
	// This is required to encrypt the data at rest if @encrypted is set to true.
	// Experimental.
	KmsKey awskms.IKey `json:"kmsKey"`
	// A policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.
	// Experimental.
	LifecyclePolicy LifecyclePolicy `json:"lifecyclePolicy"`
	// 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.
	// Experimental.
	PerformanceMode PerformanceMode `json:"performanceMode"`
	// 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.
	// Experimental.
	ProvisionedThroughputPerSecond awscdk.Size `json:"provisionedThroughputPerSecond"`
	// The removal policy to apply to the file system.
	// Experimental.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
	// Security Group to assign to this file system.
	// Experimental.
	SecurityGroup awsec2.ISecurityGroup `json:"securityGroup"`
	// Enum to mention the throughput mode of the file system.
	// Experimental.
	ThroughputMode ThroughputMode `json:"throughputMode"`
	// Which subnets to place the mount target in the VPC.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"`
}

Properties of EFS FileSystem. Experimental.

type IAccessPoint 

type IAccessPoint interface {
	awscdk.IResource
	// The ARN of the AccessPoint.
	// Experimental.
	AccessPointArn() *string
	// The ID of the AccessPoint.
	// Experimental.
	AccessPointId() *string
	// The EFS file system.
	// Experimental.
	FileSystem() IFileSystem
}

Represents an EFS AccessPoint. Experimental.

func AccessPoint_FromAccessPointAttributes 

func AccessPoint_FromAccessPointAttributes(scope constructs.Construct, id *string, attrs *AccessPointAttributes) IAccessPoint

Import an existing Access Point by attributes. Experimental.

func AccessPoint_FromAccessPointId 

func AccessPoint_FromAccessPointId(scope constructs.Construct, id *string, accessPointId *string) IAccessPoint

Import an existing Access Point by id. Experimental.

type IFileSystem 

type IFileSystem interface {
	awsec2.IConnectable
	awscdk.IResource
	// Grant the actions defined in actions to the given grantee on this File System resource.
	// Experimental.
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	// The ARN of the file system.
	// Experimental.
	FileSystemArn() *string
	// The ID of the file system, assigned by Amazon EFS.
	// Experimental.
	FileSystemId() *string
	// Dependable that can be depended upon to ensure the mount targets of the filesystem are ready.
	// Experimental.
	MountTargetsAvailable() awscdk.IDependable
}

Represents an Amazon EFS file system. Experimental.

func FileSystem_FromFileSystemAttributes 

func FileSystem_FromFileSystemAttributes(scope constructs.Construct, id *string, attrs *FileSystemAttributes) IFileSystem

Import an existing File System from the given properties. Experimental.

type LifecyclePolicy 

type LifecyclePolicy string

EFS Lifecycle Policy, if a file is not accessed for given days, it will move to EFS Infrequent Access. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html#cfn-elasticfilesystem-filesystem-lifecyclepolicies

Experimental. 

const (
	LifecyclePolicy_AFTER_7_DAYS  LifecyclePolicy = "AFTER_7_DAYS"
	LifecyclePolicy_AFTER_14_DAYS LifecyclePolicy = "AFTER_14_DAYS"
	LifecyclePolicy_AFTER_30_DAYS LifecyclePolicy = "AFTER_30_DAYS"
	LifecyclePolicy_AFTER_60_DAYS LifecyclePolicy = "AFTER_60_DAYS"
	LifecyclePolicy_AFTER_90_DAYS LifecyclePolicy = "AFTER_90_DAYS"
)

type PerformanceMode 

type PerformanceMode string

EFS Performance mode. See: https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes

Experimental. 

const (
	PerformanceMode_GENERAL_PURPOSE PerformanceMode = "GENERAL_PURPOSE"
	PerformanceMode_MAX_IO          PerformanceMode = "MAX_IO"
)

type PosixUser 

type PosixUser struct {
	// The POSIX group ID used for all file system operations using this access point.
	// Experimental.
	Gid *string `json:"gid"`
	// The POSIX user ID used for all file system operations using this access point.
	// Experimental.
	Uid *string `json:"uid"`
	// Secondary POSIX group IDs used for all file system operations using this access point.
	// Experimental.
	SecondaryGids *[]*string `json:"secondaryGids"`
}

Represents the PosixUser. Experimental.

type ThroughputMode 

type ThroughputMode string

EFS Throughput mode. See: https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes

Experimental. 

const (
	ThroughputMode_BURSTING    ThroughputMode = "BURSTING"
	ThroughputMode_PROVISIONED ThroughputMode = "PROVISIONED"
)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.