class CfnLocationFSxONTAP (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DataSync.CfnLocationFSxONTAP |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnLocationFSxONTAP |
![]() | software.amazon.awscdk.services.datasync.CfnLocationFSxONTAP |
![]() | aws_cdk.aws_datasync.CfnLocationFSxONTAP |
![]() | aws-cdk-lib » aws_datasync » CfnLocationFSxONTAP |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
The AWS::DataSync::LocationFSxONTAP
resource creates an endpoint for an Amazon FSx for NetApp ONTAP 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 { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnLocationFSxONTAP = new datasync.CfnLocationFSxONTAP(this, 'MyCfnLocationFSxONTAP', {
securityGroupArns: ['securityGroupArns'],
storageVirtualMachineArn: 'storageVirtualMachineArn',
// the properties below are optional
protocol: {
nfs: {
mountOptions: {
version: 'version',
},
},
smb: {
mountOptions: {
version: 'version',
},
password: 'password',
user: 'user',
// the properties below are optional
domain: 'domain',
},
},
subdirectory: 'subdirectory',
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnLocationFSxONTAP(scope: Construct, id: string, props: CfnLocationFSxONTAPProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Location FSx ONTAPProps
Construct Props
Name | Type | Description |
---|---|---|
security | string[] | Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system. |
storage | string | Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from. |
protocol? | IResolvable | Protocol | Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system. |
subdirectory? | string | Specifies a path to the file share in the SVM where you want to transfer data to or from. |
tags? | Cfn [] | Specifies labels that help you categorize, filter, and search for your AWS resources. |
securityGroupArns
Type:
string[]
Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system.
You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using):
- Network File System (NFS) : TCP ports 111, 635, and 2049
- Server Message Block (SMB) : TCP port 445
Your file system's security groups must also allow inbound traffic on the same port.
storageVirtualMachineArn
Type:
string
Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
protocol?
Type:
IResolvable
|
Protocol
(optional)
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
subdirectory?
Type:
string
(optional)
Specifies a path to the file share in the SVM where you want to transfer data to or from.
You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1
, /vol1/tree1
, or /share1
.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide .
tags?
Type:
Cfn
[]
(optional)
Specifies labels that help you categorize, filter, and search for your AWS resources.
We recommend creating at least a name tag for your location.
Properties
Name | Type | Description |
---|---|---|
attr | string | The ARN of the FSx for ONTAP file system in the specified location. |
attr | string | The ARN of the specified location. |
attr | string | The URI of the specified location. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
security | string[] | Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system. |
stack | Stack | The stack in which this element is defined. |
storage | string | Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from. |
tags | Tag | Tag Manager which manages the tags for this resource. |
protocol? | IResolvable | Protocol | Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system. |
subdirectory? | string | Specifies a path to the file share in the SVM where you want to transfer data to or from. |
tags | Cfn [] | Specifies labels that help you categorize, filter, and search for your AWS resources. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrFsxFilesystemArn
Type:
string
The ARN of the FSx for ONTAP file system in the specified location.
attrLocationArn
Type:
string
The ARN of the specified location.
attrLocationUri
Type:
string
The URI of the specified location.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
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)
.
node
Type:
Node
The tree node.
ref
Type:
string
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 })
.
securityGroupArns
Type:
string[]
Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
storageVirtualMachineArn
Type:
string
Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
protocol?
Type:
IResolvable
|
Protocol
(optional)
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
subdirectory?
Type:
string
(optional)
Specifies a path to the file share in the SVM where you want to transfer data to or from.
tagsRaw?
Type:
Cfn
[]
(optional)
Specifies labels that help you categorize, filter, and search for your AWS resources.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
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.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
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.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will 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.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
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.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
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)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }