@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:49.976Z") public class CfnLocationEFS extends CfnResource implements IInspectable
The AWS::DataSync::LocationEFS
resource specifies an endpoint for an Amazon EFS 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()) .efsFilesystemArn("efsFilesystemArn") // the properties below are optional .accessPointArn("accessPointArn") .fileSystemAccessRoleArn("fileSystemAccessRoleArn") .inTransitEncryption("inTransitEncryption") .subdirectory("subdirectory") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnLocationEFS.Builder
A fluent builder for
CfnLocationEFS . |
static interface |
CfnLocationEFS.Ec2ConfigProperty
The subnet and the security group that DataSync uses to access the target EFS file system.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnLocationEFS(Construct scope,
java.lang.String id,
CfnLocationEFSProps props)
Create a new `AWS::DataSync::LocationEFS`.
|
protected |
CfnLocationEFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnLocationEFS(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAccessPointArn()
`AWS::DataSync::LocationEFS.AccessPointArn`.
|
java.lang.String |
getAttrLocationArn()
The Amazon Resource Name (ARN) of the Amazon EFS file system.
|
java.lang.String |
getAttrLocationUri()
The URI of the Amazon EFS file system.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getEc2Config()
The subnet and security group that the Amazon EFS file system uses.
|
java.lang.String |
getEfsFilesystemArn()
The Amazon Resource Name (ARN) for the Amazon EFS file system.
|
java.lang.String |
getFileSystemAccessRoleArn()
`AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
|
java.lang.String |
getInTransitEncryption()
`AWS::DataSync::LocationEFS.InTransitEncryption`.
|
java.lang.String |
getSubdirectory()
A subdirectory in the location’s path.
|
TagManager |
getTags()
The key-value pair that represents a tag that you want to add to the resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAccessPointArn(java.lang.String value)
`AWS::DataSync::LocationEFS.AccessPointArn`.
|
void |
setEc2Config(CfnLocationEFS.Ec2ConfigProperty value)
The subnet and security group that the Amazon EFS file system uses.
|
void |
setEc2Config(IResolvable value)
The subnet and security group that the Amazon EFS file system uses.
|
void |
setEfsFilesystemArn(java.lang.String value)
The Amazon Resource Name (ARN) for the Amazon EFS file system.
|
void |
setFileSystemAccessRoleArn(java.lang.String value)
`AWS::DataSync::LocationEFS.FileSystemAccessRoleArn`.
|
void |
setInTransitEncryption(java.lang.String value)
`AWS::DataSync::LocationEFS.InTransitEncryption`.
|
void |
setSubdirectory(java.lang.String value)
A subdirectory in the location’s path.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnLocationEFS(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLocationEFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnLocationEFS(Construct scope, java.lang.String id, CfnLocationEFSProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrLocationArn()
public java.lang.String getAttrLocationUri()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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.
public java.lang.Object getEc2Config()
The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.
The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:
For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.
public void setEc2Config(CfnLocationEFS.Ec2ConfigProperty value)
The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.
The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:
For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.
public void setEc2Config(IResolvable value)
The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.
The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:
For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.
public java.lang.String getEfsFilesystemArn()
public void setEfsFilesystemArn(java.lang.String value)
public java.lang.String getAccessPointArn()
public void setAccessPointArn(java.lang.String value)
public java.lang.String getFileSystemAccessRoleArn()
public void setFileSystemAccessRoleArn(java.lang.String value)
public java.lang.String getInTransitEncryption()
public void setInTransitEncryption(java.lang.String value)
public java.lang.String getSubdirectory()
This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.
Subdirectory
must be specified with forward slashes. For example,/path/to/folder
.
public void setSubdirectory(java.lang.String value)
This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.
Subdirectory
must be specified with forward slashes. For example,/path/to/folder
.