Package software.amazon.awscdk.services.datasync

Class CfnLocationEFS

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationEFS
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.167Z") @Stability(Stable) public class CfnLocationEFS extends CfnResource implements IInspectable
A CloudFormation AWS::DataSync::LocationEFS.

The AWS::DataSync::LocationEFS resource creates an endpoint for an Amazon EFS file system. AWS DataSync can access this endpoint as a source or destination location.

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.datasync.*;
 CfnLocationEFS cfnLocationEFS = CfnLocationEFS.Builder.create(this, "MyCfnLocationEFS")
         .ec2Config(Ec2ConfigProperty.builder()
                 .securityGroupArns(List.of("securityGroupArns"))
                 .subnetArn("subnetArn")
                 .build())
         // the properties below are optional
         .accessPointArn("accessPointArn")
         .efsFilesystemArn("efsFilesystemArn")
         .fileSystemAccessRoleArn("fileSystemAccessRoleArn")
         .inTransitEncryption("inTransitEncryption")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnLocationEFS

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

    • CfnLocationEFS

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

    • CfnLocationEFS

      @Stability(Stable) public CfnLocationEFS(@NotNull Construct scope, @NotNull String id, @NotNull CfnLocationEFSProps props)
      Create a new AWS::DataSync::LocationEFS.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      The Amazon Resource Name (ARN) of the Amazon EFS file system.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the Amazon EFS file system.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Specifies the key-value pair that represents a tag that you want to add to the resource.

      The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

    • getEc2Config

      @Stability(Stable) @NotNull public Object getEc2Config()
      Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

    • setEc2Config

      @Stability(Stable) public void setEc2Config(@NotNull CfnLocationEFS.Ec2ConfigProperty value)
      Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

    • setEc2Config

      @Stability(Stable) public void setEc2Config(@NotNull IResolvable value)
      Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

    • getAccessPointArn

      @Stability(Stable) @Nullable public String getAccessPointArn()
      Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

    • setAccessPointArn

      @Stability(Stable) public void setAccessPointArn(@Nullable String value)
      Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

    • getEfsFilesystemArn

      @Stability(Stable) @Nullable public String getEfsFilesystemArn()
      Specifies the ARN for the Amazon EFS file system.

    • setEfsFilesystemArn

      @Stability(Stable) public void setEfsFilesystemArn(@Nullable String value)
      Specifies the ARN for the Amazon EFS file system.

    • getFileSystemAccessRoleArn

      @Stability(Stable) @Nullable public String getFileSystemAccessRoleArn()
      Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

    • setFileSystemAccessRoleArn

      @Stability(Stable) public void setFileSystemAccessRoleArn(@Nullable String value)
      Specifies an AWS Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

    • getInTransitEncryption

      @Stability(Stable) @Nullable public String getInTransitEncryption()
      Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.

      If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn , you must set this parameter to TLS1_2 .

    • setInTransitEncryption

      @Stability(Stable) public void setInTransitEncryption(@Nullable String value)
      Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.

      If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn , you must set this parameter to TLS1_2 .

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      Specifies a mount path for your Amazon EFS file system.

      This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

      You must specify a value with forward slashes (for example, /path/to/folder ).

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies a mount path for your Amazon EFS file system.

      This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

      You must specify a value with forward slashes (for example, /path/to/folder ).