class CfnLocationSMB (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DataSync.CfnLocationSMB |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnLocationSMB |
![]() | software.amazon.awscdk.services.datasync.CfnLocationSMB |
![]() | aws_cdk.aws_datasync.CfnLocationSMB |
![]() | aws-cdk-lib » aws_datasync » CfnLocationSMB |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
The AWS::DataSync::LocationSMB
resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html
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 cfnLocationSMB = new datasync.CfnLocationSMB(this, 'MyCfnLocationSMB', {
agentArns: ['agentArns'],
// the properties below are optional
authenticationType: 'authenticationType',
dnsIpAddresses: ['dnsIpAddresses'],
domain: 'domain',
kerberosKeytab: 'kerberosKeytab',
kerberosKrb5Conf: 'kerberosKrb5Conf',
kerberosPrincipal: 'kerberosPrincipal',
mountOptions: {
version: 'version',
},
password: 'password',
serverHostname: 'serverHostname',
subdirectory: 'subdirectory',
tags: [{
key: 'key',
value: 'value',
}],
user: 'user',
});
Initializer
new CfnLocationSMB(scope: Construct, id: string, props: CfnLocationSMBProps)
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 SMBProps
Construct Props
Name | Type | Description |
---|---|---|
agent | string[] | Specifies the DataSync agent (or agents) that can connect to your SMB file server. |
authentication | string | Specifies the authentication protocol that DataSync uses to connect to your SMB file server. |
dns | string[] | Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. |
domain? | string | Specifies the Windows domain name that your SMB file server belongs to. |
kerberos | string | Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys. |
kerberos | string | Specifies a Kerberos configuration file ( krb5.conf ) that defines your Kerberos realm configuration. |
kerberos | string | Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. |
mount | IResolvable | Mount | Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. |
password? | string | Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. |
server | string | Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount. |
subdirectory? | string | Specifies the name of the share exported by your SMB file server where DataSync will read or write data. |
tags? | Cfn [] | Specifies labels that help you categorize, filter, and search for your AWS resources. |
user? | string | Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. |
agentArns
Type:
string[]
Specifies the DataSync agent (or agents) that can connect to your SMB file server.
You specify an agent by using its Amazon Resource Name (ARN).
authenticationType?
Type:
string
(optional)
Specifies the authentication protocol that DataSync uses to connect to your SMB file server.
DataSync supports NTLM
(default) and KERBEROS
authentication.
For more information, see Providing DataSync access to SMB file servers .
dnsIpAddresses?
Type:
string[]
(optional)
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.
This parameter applies only if AuthenticationType
is set to KERBEROS
.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
domain?
Type:
string
(optional)
Specifies the Windows domain name that your SMB file server belongs to.
This parameter applies only if AuthenticationType
is set to NTLM
.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
kerberosKeytab?
Type:
string
(optional)
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
The file must be base64 encoded.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal
.
kerberosKrb5Conf?
Type:
string
(optional)
Specifies a Kerberos configuration file ( krb5.conf
) that defines your Kerberos realm configuration.
The file must be base64 encoded.
kerberosPrincipal?
Type:
string
(optional)
Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG
.
Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
mountOptions?
Type:
IResolvable
|
Mount
(optional)
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
password?
Type:
string
(optional)
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.
This parameter applies only if AuthenticationType
is set to NTLM
.
serverHostname?
Type:
string
(optional)
Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount.
Remember the following when configuring this parameter:
- You can't specify an IP version 6 (IPv6) address.
- If you're using Kerberos authentication, you must specify a domain name.
subdirectory?
Type:
string
(optional)
Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
You can include a subdirectory in the share path (for example, /path/to/subdirectory
). Make sure that other SMB clients in your network can also mount this path.
To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers .
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.
user?
Type:
string
(optional)
Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.
This parameter applies only if AuthenticationType
is set to NTLM
.
For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers .
Properties
Name | Type | Description |
---|---|---|
agent | string[] | Specifies the DataSync agent (or agents) that can connect to your SMB file server. |
attr | string | The Amazon Resource Name (ARN) of the specified SMB location. |
attr | string | The URI of the specified SMB 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. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
authentication | string | Specifies the authentication protocol that DataSync uses to connect to your SMB file server. |
dns | string[] | Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. |
domain? | string | Specifies the Windows domain name that your SMB file server belongs to. |
kerberos | string | Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys. |
kerberos | string | Specifies a Kerberos configuration file ( krb5.conf ) that defines your Kerberos realm configuration. |
kerberos | string | Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. |
mount | IResolvable | Mount | Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. |
password? | string | Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. |
server | string | Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount. |
subdirectory? | string | Specifies the name of the share exported by your SMB file server where DataSync will read or write data. |
tags | Cfn [] | Specifies labels that help you categorize, filter, and search for your AWS resources. |
user? | string | Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
agentArns
Type:
string[]
Specifies the DataSync agent (or agents) that can connect to your SMB file server.
attrLocationArn
Type:
string
The Amazon Resource Name (ARN) of the specified SMB location.
attrLocationUri
Type:
string
The URI of the specified SMB 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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
authenticationType?
Type:
string
(optional)
Specifies the authentication protocol that DataSync uses to connect to your SMB file server.
dnsIpAddresses?
Type:
string[]
(optional)
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.
domain?
Type:
string
(optional)
Specifies the Windows domain name that your SMB file server belongs to.
kerberosKeytab?
Type:
string
(optional)
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
kerberosKrb5Conf?
Type:
string
(optional)
Specifies a Kerberos configuration file ( krb5.conf
) that defines your Kerberos realm configuration.
kerberosPrincipal?
Type:
string
(optional)
Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
mountOptions?
Type:
IResolvable
|
Mount
(optional)
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
password?
Type:
string
(optional)
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.
serverHostname?
Type:
string
(optional)
Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount.
subdirectory?
Type:
string
(optional)
Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
tagsRaw?
Type:
Cfn
[]
(optional)
Specifies labels that help you categorize, filter, and search for your AWS resources.
user?
Type:
string
(optional)
Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.
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.
See also: [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.](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.
See also: [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.](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 }