aws-cdk-lib

import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { AccessPointReference, FileSystemPolicyReference, FileSystemReference, IAccessPointRef, IFileSystemPolicyRef, IFileSystemRef, IMountTargetRef, MountTargetReference } from "../../interfaces/generated/aws-s3files-interfaces.generated"; /** * Resource Type definition for AWS::S3Files::AccessPoint. * * @cloudformationResource AWS::S3Files::AccessPoint * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html */ export declare class CfnAccessPoint extends cdk.CfnResource implements cdk.IInspectable, IAccessPointRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAccessPoint from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAccessPoint; /** * Checks whether the given object is a CfnAccessPoint */ static isCfnAccessPoint(x: any): x is CfnAccessPoint; static arnForAccessPoint(resource: IAccessPointRef): string; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; /** * (optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation. */ private _clientToken?; /** * The ID of the S3 Files file system that the access point provides access to. */ private _fileSystemId; private _posixUser?; private _rootDirectory?; private _tags?; /** * Create a new `AWS::S3Files::AccessPoint`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAccessPointProps); get accessPointRef(): AccessPointReference; /** * (optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation. */ get clientToken(): string | undefined; /** * (optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation. */ set clientToken(value: string | undefined); /** * The ID of the S3 Files file system that the access point provides access to. */ get fileSystemId(): string; /** * The ID of the S3 Files file system that the access point provides access to. */ set fileSystemId(value: string); get posixUser(): cdk.IResolvable | CfnAccessPoint.PosixUserProperty | undefined; set posixUser(value: cdk.IResolvable | CfnAccessPoint.PosixUserProperty | undefined); get rootDirectory(): cdk.IResolvable | CfnAccessPoint.RootDirectoryProperty | undefined; set rootDirectory(value: cdk.IResolvable | CfnAccessPoint.RootDirectoryProperty | undefined); get tags(): Array<CfnAccessPoint.AccessPointTagProperty> | undefined; set tags(value: Array<CfnAccessPoint.AccessPointTagProperty> | undefined); /** * @cloudformationAttribute AccessPointArn */ get attrAccessPointArn(): string; /** * @cloudformationAttribute AccessPointId */ get attrAccessPointId(): string; /** * @cloudformationAttribute OwnerId */ get attrOwnerId(): string; /** * @cloudformationAttribute Status */ get attrStatus(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnAccessPoint { /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-accesspointtag.html */ interface AccessPointTagProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-accesspointtag.html#cfn-s3files-accesspoint-accesspointtag-key */ readonly key?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-accesspointtag.html#cfn-s3files-accesspoint-accesspointtag-value */ readonly value?: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-posixuser.html */ interface PosixUserProperty { /** * The POSIX group ID used for all file system operations using this access point. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-posixuser.html#cfn-s3files-accesspoint-posixuser-gid */ readonly gid: string; /** * Secondary POSIX group IDs used for all file system operations using this access point. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-posixuser.html#cfn-s3files-accesspoint-posixuser-secondarygids */ readonly secondaryGids?: Array<string>; /** * The POSIX user ID used for all file system operations using this access point. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-posixuser.html#cfn-s3files-accesspoint-posixuser-uid */ readonly uid: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-rootdirectory.html */ interface RootDirectoryProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-rootdirectory.html#cfn-s3files-accesspoint-rootdirectory-creationpermissions */ readonly creationPermissions?: CfnAccessPoint.CreationPermissionsProperty | cdk.IResolvable; /** * 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. * * A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationPermissions. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-rootdirectory.html#cfn-s3files-accesspoint-rootdirectory-path */ readonly path?: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-creationpermissions.html */ interface CreationPermissionsProperty { /** * Specifies the POSIX group ID to apply to the RootDirectory. * * Accepts values from 0 to 2^32 (4294967295). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-creationpermissions.html#cfn-s3files-accesspoint-creationpermissions-ownergid */ readonly ownerGid: string; /** * Specifies the POSIX user ID to apply to the RootDirectory. * * Accepts values from 0 to 2^32 (4294967295). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-creationpermissions.html#cfn-s3files-accesspoint-creationpermissions-owneruid */ readonly ownerUid: string; /** * Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-accesspoint-creationpermissions.html#cfn-s3files-accesspoint-creationpermissions-permissions */ readonly permissions: string; } } /** * Properties for defining a `CfnAccessPoint` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html */ export interface CfnAccessPointProps { /** * (optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html#cfn-s3files-accesspoint-clienttoken */ readonly clientToken?: string; /** * The ID of the S3 Files file system that the access point provides access to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html#cfn-s3files-accesspoint-filesystemid */ readonly fileSystemId: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html#cfn-s3files-accesspoint-posixuser */ readonly posixUser?: cdk.IResolvable | CfnAccessPoint.PosixUserProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html#cfn-s3files-accesspoint-rootdirectory */ readonly rootDirectory?: cdk.IResolvable | CfnAccessPoint.RootDirectoryProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html#cfn-s3files-accesspoint-tags */ readonly tags?: Array<CfnAccessPoint.AccessPointTagProperty>; } /** * Resource Type definition for AWS::S3Files::FileSystem. * * @cloudformationResource AWS::S3Files::FileSystem * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html */ export declare class CfnFileSystem extends cdk.CfnResource implements cdk.IInspectable, IFileSystemRef, cdk.ITaggableV2 { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFileSystem from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnFileSystem; /** * Checks whether the given object is a CfnFileSystem */ static isCfnFileSystem(x: any): x is CfnFileSystem; static arnForFileSystem(resource: IFileSystemRef): string; private _acceptBucketWarning?; private _bucket; /** * Tag Manager which manages the tags for this resource */ readonly cdkTagManager: cdk.TagManager; private _clientToken?; private _kmsKeyId?; private _prefix?; private _roleArn; private _synchronizationConfiguration?; private _tags?; /** * Create a new `AWS::S3Files::FileSystem`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnFileSystemProps); get fileSystemRef(): FileSystemReference; get acceptBucketWarning(): boolean | cdk.IResolvable | undefined; set acceptBucketWarning(value: boolean | cdk.IResolvable | undefined); get bucket(): string; set bucket(value: string); get clientToken(): string | undefined; set clientToken(value: string | undefined); get kmsKeyId(): string | undefined; set kmsKeyId(value: string | undefined); get prefix(): string | undefined; set prefix(value: string | undefined); get roleArn(): string; set roleArn(value: string); get synchronizationConfiguration(): cdk.IResolvable | CfnFileSystem.SynchronizationConfigurationProperty | undefined; set synchronizationConfiguration(value: cdk.IResolvable | CfnFileSystem.SynchronizationConfigurationProperty | undefined); get tags(): Array<cdk.CfnTag> | undefined; set tags(value: Array<cdk.CfnTag> | undefined); /** * @cloudformationAttribute CreationTime */ get attrCreationTime(): string; /** * @cloudformationAttribute FileSystemArn */ get attrFileSystemArn(): string; /** * @cloudformationAttribute FileSystemId */ get attrFileSystemId(): string; /** * @cloudformationAttribute OwnerId */ get attrOwnerId(): string; /** * @cloudformationAttribute Status */ get attrStatus(): string; /** * @cloudformationAttribute StatusMessage */ get attrStatusMessage(): string; /** * @cloudformationAttribute SynchronizationConfiguration.LatestVersionNumber */ get attrSynchronizationConfigurationLatestVersionNumber(): number; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnFileSystem { /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-synchronizationconfiguration.html */ interface SynchronizationConfigurationProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-synchronizationconfiguration.html#cfn-s3files-filesystem-synchronizationconfiguration-expirationdatarules */ readonly expirationDataRules: Array<CfnFileSystem.ExpirationDataRuleProperty | cdk.IResolvable> | cdk.IResolvable; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-synchronizationconfiguration.html#cfn-s3files-filesystem-synchronizationconfiguration-importdatarules */ readonly importDataRules: Array<CfnFileSystem.ImportDataRuleProperty | cdk.IResolvable> | cdk.IResolvable; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-synchronizationconfiguration.html#cfn-s3files-filesystem-synchronizationconfiguration-latestversionnumber */ readonly latestVersionNumber?: number; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-importdatarule.html */ interface ImportDataRuleProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-importdatarule.html#cfn-s3files-filesystem-importdatarule-prefix */ readonly prefix: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-importdatarule.html#cfn-s3files-filesystem-importdatarule-sizelessthan */ readonly sizeLessThan: number; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-importdatarule.html#cfn-s3files-filesystem-importdatarule-trigger */ readonly trigger: string; } /** * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-expirationdatarule.html */ interface ExpirationDataRuleProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3files-filesystem-expirationdatarule.html#cfn-s3files-filesystem-expirationdatarule-daysafterlastaccess */ readonly daysAfterLastAccess: number; } } /** * Properties for defining a `CfnFileSystem` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html */ export interface CfnFileSystemProps { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-acceptbucketwarning */ readonly acceptBucketWarning?: boolean | cdk.IResolvable; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-bucket */ readonly bucket: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-clienttoken */ readonly clientToken?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-kmskeyid */ readonly kmsKeyId?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-prefix */ readonly prefix?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-rolearn */ readonly roleArn: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-synchronizationconfiguration */ readonly synchronizationConfiguration?: cdk.IResolvable | CfnFileSystem.SynchronizationConfigurationProperty; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystem.html#cfn-s3files-filesystem-tags */ readonly tags?: Array<cdk.CfnTag>; } /** * Resource Type definition for AWS::S3Files::FileSystemPolicy. * * @cloudformationResource AWS::S3Files::FileSystemPolicy * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystempolicy.html */ export declare class CfnFileSystemPolicy extends cdk.CfnResource implements cdk.IInspectable, IFileSystemPolicyRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnFileSystemPolicy from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnFileSystemPolicy; /** * Checks whether the given object is a CfnFileSystemPolicy */ static isCfnFileSystemPolicy(x: any): x is CfnFileSystemPolicy; private _fileSystemId; private _policy; /** * Create a new `AWS::S3Files::FileSystemPolicy`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnFileSystemPolicyProps); get fileSystemPolicyRef(): FileSystemPolicyReference; get fileSystemId(): string; set fileSystemId(value: string); get policy(): any | cdk.IResolvable; set policy(value: any | cdk.IResolvable); protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnFileSystemPolicy` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystempolicy.html */ export interface CfnFileSystemPolicyProps { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystempolicy.html#cfn-s3files-filesystempolicy-filesystemid */ readonly fileSystemId: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystempolicy.html#cfn-s3files-filesystempolicy-policy */ readonly policy: any | cdk.IResolvable; } /** * Resource Type definition for AWS::S3Files::MountTarget. * * @cloudformationResource AWS::S3Files::MountTarget * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html */ export declare class CfnMountTarget extends cdk.CfnResource implements cdk.IInspectable, IMountTargetRef { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnMountTarget from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMountTarget; /** * Checks whether the given object is a CfnMountTarget */ static isCfnMountTarget(x: any): x is CfnMountTarget; private _fileSystemId; private _ipAddressType?; private _ipv4Address?; private _ipv6Address?; private _securityGroups?; private _subnetId; /** * Create a new `AWS::S3Files::MountTarget`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnMountTargetProps); get mountTargetRef(): MountTargetReference; get fileSystemId(): string; set fileSystemId(value: string); get ipAddressType(): string | undefined; set ipAddressType(value: string | undefined); get ipv4Address(): string | undefined; set ipv4Address(value: string | undefined); get ipv6Address(): string | undefined; set ipv6Address(value: string | undefined); get securityGroups(): Array<string> | undefined; set securityGroups(value: Array<string> | undefined); get subnetId(): string; set subnetId(value: string); /** * @cloudformationAttribute AvailabilityZoneId */ get attrAvailabilityZoneId(): string; /** * @cloudformationAttribute MountTargetId */ get attrMountTargetId(): string; /** * @cloudformationAttribute NetworkInterfaceId */ get attrNetworkInterfaceId(): string; /** * @cloudformationAttribute OwnerId */ get attrOwnerId(): string; /** * @cloudformationAttribute Status */ get attrStatus(): string; /** * @cloudformationAttribute StatusMessage */ get attrStatusMessage(): string; /** * @cloudformationAttribute VpcId */ get attrVpcId(): string; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnMountTarget` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html */ export interface CfnMountTargetProps { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html#cfn-s3files-mounttarget-filesystemid */ readonly fileSystemId: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html#cfn-s3files-mounttarget-ipaddresstype */ readonly ipAddressType?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html#cfn-s3files-mounttarget-ipv4address */ readonly ipv4Address?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html#cfn-s3files-mounttarget-ipv6address */ readonly ipv6Address?: string; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html#cfn-s3files-mounttarget-securitygroups */ readonly securityGroups?: Array<string>; /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-mounttarget.html#cfn-s3files-mounttarget-subnetid */ readonly subnetId: string; } export type { IAccessPointRef, AccessPointReference }; export type { IFileSystemRef, FileSystemReference }; export type { IFileSystemPolicyRef, FileSystemPolicyReference }; export type { IMountTargetRef, MountTargetReference };