CfnAccessPoint
- class aws_cdk.aws_s3files.CfnAccessPoint(scope, id, *, file_system_id, client_token=None, posix_user=None, root_directory=None, tags=None)
Bases:
CfnResourceResource Type definition for AWS::S3Files::AccessPoint.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-accesspoint.html
- CloudformationResource:
AWS::S3Files::AccessPoint
- ExampleMetadata:
infused
Example:
import aws_cdk as cdk import aws_cdk.aws_ec2 as ec2 import aws_cdk.aws_s3 as s3 import aws_cdk.aws_s3files as s3files vpc = ec2.Vpc(self, "Vpc") # Versioning is required — S3 Files relies on object versions for consistency. bucket = s3.Bucket(self, "Bucket", versioned=True) # S3 Files assumes this role to sync data between S3 and the file system. role = iam.Role(self, "S3FilesRole", assumed_by=iam.ServicePrincipal("elasticfilesystem.amazonaws.com") ) # S3 permissions: read/write access to the bucket and objects role.add_to_policy(iam.PolicyStatement( actions=["s3:ListBucket*"], resources=[bucket.bucket_arn] )) role.add_to_policy(iam.PolicyStatement( actions=["s3:AbortMultipartUpload", "s3:DeleteObject", "s3:GetObject*", "s3:List*", "s3:PutObject*"], resources=[bucket.arn_for_objects("*")] )) # EventBridge permissions: S3 Files creates rules prefixed "DO-NOT-DELETE-S3-Files" # to detect S3 object changes and trigger data synchronization. role.add_to_policy(iam.PolicyStatement( actions=["events:DeleteRule", "events:DisableRule", "events:EnableRule", "events:PutRule", "events:PutTargets", "events:RemoveTargets" ], resources=[f"arn:{cdk.Aws.PARTITION}:events:*:*:rule/DO-NOT-DELETE-S3-Files*"], conditions={"StringEquals": {"events:ManagedBy": "elasticfilesystem.amazonaws.com"}} )) role.add_to_policy(iam.PolicyStatement( actions=["events:DescribeRule", "events:ListRuleNamesByTarget", "events:ListRules", "events:ListTargetsByRule"], resources=[f"arn:{cdk.Aws.PARTITION}:events:*:*:rule/*"] )) file_system = s3files.CfnFileSystem(self, "S3FilesFs", bucket=bucket.bucket_arn, role_arn=role.role_arn ) sg = ec2.SecurityGroup(self, "MountTargetSG", vpc=vpc) # Create a mount target in each private subnet so Lambda can reach the file system via NFS. vpc.private_subnets.for_each((subnet, i) => new s3files.CfnMountTarget(this, `MountTarget${i}`, { fileSystemId: fileSystem.attrFileSystemId, subnetId: subnet.subnetId, securityGroups: [sg.securityGroupId], })) # The access point defines the POSIX identity and root path Lambda uses on the file system. access_point = s3files.CfnAccessPoint(self, "AccessPoint", file_system_id=file_system.attr_file_system_id, root_directory=s3files.CfnAccessPoint.RootDirectoryProperty( path="/export/lambda", creation_permissions=s3files.CfnAccessPoint.CreationPermissionsProperty(owner_gid="1001", owner_uid="1001", permissions="750") ), posix_user=s3files.CfnAccessPoint.PosixUserProperty(gid="1001", uid="1001") ) fn = lambda_.Function(self, "MyFunction", runtime=lambda_.Runtime.NODEJS_LATEST, handler="index.handler", code=lambda_.Code.from_asset(path.join(__dirname, "lambda-handler")), vpc=vpc, filesystem=lambda_.FileSystem.from_s3_files_access_point(access_point, "/mnt/s3files") )Create a new
AWS::S3Files::AccessPoint.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).file_system_id (
str) – The ID of the S3 Files file system that the access point provides access to.client_token (
Optional[str]) – (optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.posix_user (
Union[IResolvable,PosixUserProperty,Dict[str,Any],None])root_directory (
Union[IResolvable,RootDirectoryProperty,Dict[str,Any],None])tags (
Optional[Sequence[Union[AccessPointTagProperty,Dict[str,Any]]]])
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource)- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
- with_(*mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple
with()calls if subsequent mixins should apply to added constructs.- Parameters:
mixins (
IMixin)- Return type:
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::S3Files::AccessPoint'
- access_point_ref
A reference to a AccessPoint resource.
- attr_access_point_arn
AccessPointArn
- Type:
cloudformationAttribute
- attr_access_point_id
AccessPointId
- Type:
cloudformationAttribute
- attr_owner_id
OwnerId
- Type:
cloudformationAttribute
- attr_status
Status
- Type:
cloudformationAttribute
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- client_token
(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- env
- file_system_id
The ID of the S3 Files file system that the access point provides access to.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- posix_user
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- root_directory
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Static Methods
- classmethod arn_for_access_point(resource)
- Parameters:
resource (
IAccessPointRef)- Return type:
str
- classmethod is_cfn_access_point(x)
Checks whether the given object is a CfnAccessPoint.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
AccessPointTagProperty
- class CfnAccessPoint.AccessPointTagProperty(*, key=None, value=None)
Bases:
object- Parameters:
key (
Optional[str])value (
Optional[str])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_s3files as s3files access_point_tag_property = s3files.CfnAccessPoint.AccessPointTagProperty( key="key", value="value" )
Attributes
- key
-
- Type:
see
CreationPermissionsProperty
- class CfnAccessPoint.CreationPermissionsProperty(*, owner_gid, owner_uid, permissions)
Bases:
object- Parameters:
owner_gid (
str) – Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).owner_uid (
str) – Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).permissions (
str) – Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_s3files as s3files creation_permissions_property = s3files.CfnAccessPoint.CreationPermissionsProperty( owner_gid="ownerGid", owner_uid="ownerUid", permissions="permissions" )
Attributes
- owner_gid
Specifies the POSIX group ID to apply to the RootDirectory.
Accepts values from 0 to 2^32 (4294967295).
- owner_uid
Specifies the POSIX user ID to apply to the RootDirectory.
Accepts values from 0 to 2^32 (4294967295).
- permissions
Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.
PosixUserProperty
- class CfnAccessPoint.PosixUserProperty(*, gid, uid, secondary_gids=None)
Bases:
object- Parameters:
gid (
str) – The POSIX group ID used for all file system operations using this access point.uid (
str) – The POSIX user ID used for all file system operations using this access point.secondary_gids (
Optional[Sequence[str]]) – Secondary POSIX group IDs used for all file system operations using this access point.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_s3files as s3files posix_user_property = s3files.CfnAccessPoint.PosixUserProperty( gid="gid", uid="uid", # the properties below are optional secondary_gids=["secondaryGids"] )
Attributes
- gid
The POSIX group ID used for all file system operations using this access point.
- secondary_gids
Secondary POSIX group IDs used for all file system operations using this access point.
- uid
The POSIX user ID used for all file system operations using this access point.
RootDirectoryProperty
- class CfnAccessPoint.RootDirectoryProperty(*, creation_permissions=None, path=None)
Bases:
object- Parameters:
creation_permissions (
Union[IResolvable,CreationPermissionsProperty,Dict[str,Any],None])path (
Optional[str]) – 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:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_s3files as s3files root_directory_property = s3files.CfnAccessPoint.RootDirectoryProperty( creation_permissions=s3files.CfnAccessPoint.CreationPermissionsProperty( owner_gid="ownerGid", owner_uid="ownerUid", permissions="permissions" ), path="path" )
Attributes
- creation_permissions
-
- Type:
see
- path
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.