Package software.amazon.awscdk.services.fsx

Class CfnS3AccessPointAttachment

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.fsx.CfnS3AccessPointAttachment
All Implemented Interfaces:
IInspectable, IS3AccessPointAttachmentRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:21.510Z") @Stability(Stable) public class CfnS3AccessPointAttachment extends CfnResource implements IInspectable, IS3AccessPointAttachmentRef
An S3 access point attached to an Amazon FSx volume.

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.fsx.*;
 Object policy;
 CfnS3AccessPointAttachment cfnS3AccessPointAttachment = CfnS3AccessPointAttachment.Builder.create(this, "MyCfnS3AccessPointAttachment")
         .name("name")
         .openZfsConfiguration(S3AccessPointOpenZFSConfigurationProperty.builder()
                 .fileSystemIdentity(OpenZFSFileSystemIdentityProperty.builder()
                         .posixUser(OpenZFSPosixFileSystemUserProperty.builder()
                                 .gid(123)
                                 .uid(123)
                                 // the properties below are optional
                                 .secondaryGids(List.of(FileSystemGIDProperty.builder()
                                         .gid(123)
                                         .build()))
                                 .build())
                         .type("type")
                         .build())
                 .volumeId("volumeId")
                 .build())
         .type("type")
         // the properties below are optional
         .s3AccessPoint(S3AccessPointProperty.builder()
                 .alias("alias")
                 .policy(policy)
                 .resourceArn("resourceArn")
                 .vpcConfiguration(S3AccessPointVpcConfigurationProperty.builder()
                         .vpcId("vpcId")
                         .build())
                 .build())
         .build();

See Also:

  • 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

    • CfnS3AccessPointAttachment

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

    • CfnS3AccessPointAttachment

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

    • CfnS3AccessPointAttachment

      @Stability(Stable) public CfnS3AccessPointAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnS3AccessPointAttachmentProps props)
      Create a new AWS::FSx::S3AccessPointAttachment.

      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

    • isCfnS3AccessPointAttachment

      @Stability(Stable) @NotNull public static Boolean isCfnS3AccessPointAttachment(@NotNull Object x)
      Checks whether the given object is a CfnS3AccessPointAttachment.

      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.

    • getAttrS3AccessPointAlias

      @Stability(Stable) @NotNull public String getAttrS3AccessPointAlias()
      The S3 access point's alias.

    • getAttrS3AccessPointResourceArn

      @Stability(Stable) @NotNull public String getAttrS3AccessPointResourceArn()
      The S3 access point's ARN.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getS3AccessPointAttachmentRef

      @Stability(Stable) @NotNull public S3AccessPointAttachmentReference getS3AccessPointAttachmentRef()
      A reference to a S3AccessPointAttachment resource.
      Specified by:
      getS3AccessPointAttachmentRef in interface IS3AccessPointAttachmentRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the S3 access point attachment;

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the S3 access point attachment;

    • getOpenZfsConfiguration

      @Stability(Stable) @NotNull public Object getOpenZfsConfiguration()
      The OpenZFSConfiguration of the S3 access point attachment.

      Returns union: either IResolvable or CfnS3AccessPointAttachment.S3AccessPointOpenZFSConfigurationProperty

    • setOpenZfsConfiguration

      @Stability(Stable) public void setOpenZfsConfiguration(@NotNull IResolvable value)
      The OpenZFSConfiguration of the S3 access point attachment.

    • setOpenZfsConfiguration

      @Stability(Stable) public void setOpenZfsConfiguration(@NotNull CfnS3AccessPointAttachment.S3AccessPointOpenZFSConfigurationProperty value)
      The OpenZFSConfiguration of the S3 access point attachment.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of Amazon FSx volume that the S3 access point is attached to.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of Amazon FSx volume that the S3 access point is attached to.

    • getS3AccessPoint

      @Stability(Stable) @Nullable public Object getS3AccessPoint()
      The S3 access point configuration of the S3 access point attachment.

      Returns union: either IResolvable or CfnS3AccessPointAttachment.S3AccessPointProperty

    • setS3AccessPoint

      @Stability(Stable) public void setS3AccessPoint(@Nullable IResolvable value)
      The S3 access point configuration of the S3 access point attachment.

    • setS3AccessPoint

      @Stability(Stable) public void setS3AccessPoint(@Nullable CfnS3AccessPointAttachment.S3AccessPointProperty value)
      The S3 access point configuration of the S3 access point attachment.