Package software.amazon.awscdk.services.s3files

Class CfnFileSystemPolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.s3files.CfnFileSystemPolicy

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IFileSystemPolicyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-14T18:32:03.776Z")
@Stability(Stable)
public class CfnFileSystemPolicy
extends CfnResource
implements IInspectable, IFileSystemPolicyRef

Resource Type definition for AWS::S3Files::FileSystemPolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3files.*;
 Object policy;
 CfnFileSystemPolicy cfnFileSystemPolicy = CfnFileSystemPolicy.Builder.create(this, "MyCfnFileSystemPolicy")
         .fileSystemId("fileSystemId")
         .policy(policy)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3files-filesystempolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnFileSystemPolicy.Builder	A fluent builder for CfnFileSystemPolicy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.s3files.IFileSystemPolicyRef

IFileSystemPolicyRef.Jsii$Default, IFileSystemPolicyRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnFileSystemPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFileSystemPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CfnFileSystemPolicy(software.constructs.Construct scope, String id, CfnFileSystemPolicyProps props)	Create a new AWS::S3Files::FileSystemPolicy.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getFileSystemId()
FileSystemPolicyReference	getFileSystemPolicyRef()	A reference to a FileSystemPolicy resource.
Object	getPolicy()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnFileSystemPolicy(Object x)	Checks whether the given object is a CfnFileSystemPolicy.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFileSystemId(String value)
void	setPolicy(Object value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnFileSystemPolicy

protected CfnFileSystemPolicy(software.amazon.jsii.JsiiObjectRef objRef)

CfnFileSystemPolicy

protected CfnFileSystemPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFileSystemPolicy

@Stability(Stable)
public CfnFileSystemPolicy(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnFileSystemPolicyProps props)

Create a new AWS::S3Files::FileSystemPolicy.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnFileSystemPolicy

@Stability(Stable)
@NotNull
public static Boolean isCfnFileSystemPolicy(@NotNull
 Object x)

Checks whether the given object is a CfnFileSystemPolicy.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFileSystemPolicyRef

@Stability(Stable)
@NotNull
public FileSystemPolicyReference getFileSystemPolicyRef()

A reference to a FileSystemPolicy resource.

Specified by:

getFileSystemPolicyRef in interface IFileSystemPolicyRef

getFileSystemId

@Stability(Stable)
@NotNull
public String getFileSystemId()

setFileSystemId

@Stability(Stable)
public void setFileSystemId(@NotNull
 String value)

getPolicy

@Stability(Stable)
@NotNull
public Object getPolicy()

setPolicy

@Stability(Stable)
public void setPolicy(@NotNull
 Object value)