Class CfnLocationFSxWindows

The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server file system.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnLocationFSxWindows

Implements

IInspectable

ILocationFSxWindowsRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DataSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnLocationFSxWindows : CfnResource, IInspectable, ILocationFSxWindowsRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnLocationFSxWindows Inherits CfnResource Implements IInspectable, ILocationFSxWindowsRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DataSync;

             var cfnLocationFSxWindows = new CfnLocationFSxWindows(this, "MyCfnLocationFSxWindows", new CfnLocationFSxWindowsProps {
                 SecurityGroupArns = new [] { "securityGroupArns" },
                 User = "user",

                 // the properties below are optional
                 CmkSecretConfig = new CmkSecretConfigProperty {
                     KmsKeyArn = "kmsKeyArn",
                     SecretArn = "secretArn"
                 },
                 CustomSecretConfig = new CustomSecretConfigProperty {
                     SecretAccessRoleArn = "secretAccessRoleArn",
                     SecretArn = "secretArn"
                 },
                 Domain = "domain",
                 FsxFilesystemArn = "fsxFilesystemArn",
                 Password = "password",
                 Subdirectory = "subdirectory",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnLocationFSxWindows(Construct, string, ICfnLocationFSxWindowsProps)

Create a new AWS::DataSync::LocationFSxWindows.

Properties

AttrCmkSecretConfigSecretArn	Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
AttrLocationArn	The ARN of the specified FSx for Windows Server file system location.
AttrLocationUri	The URI of the specified FSx for Windows Server file system location.
AttrManagedSecretConfig	Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The `AWS::DataSync::LocationFSxWindows` resource specifies an endpoint for an Amazon FSx for Windows Server file system.
CfnPropertyNames	The `AWS::DataSync::LocationFSxWindows` resource specifies an endpoint for an Amazon FSx for Windows Server file system.
CmkSecretConfig	Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
CustomSecretConfig	Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
Domain	Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.
FsxFilesystemArn	Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
LocationFSxWindowsRef	A reference to a LocationFSxWindows resource.
Password	Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
SecurityGroupArns	The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.
Subdirectory	Specifies a mount path for your file system using forward slashes.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Specifies labels that help you categorize, filter, and search for your AWS resources.
User	The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnLocationFSxWindows(object)	Checks whether the given object is a CfnLocationFSxWindows.
RenderProperties(IDictionary<string, object>)	The `AWS::DataSync::LocationFSxWindows` resource specifies an endpoint for an Amazon FSx for Windows Server file system.

Constructors

CfnLocationFSxWindows(Construct, string, ICfnLocationFSxWindowsProps)

Create a new AWS::DataSync::LocationFSxWindows.

public CfnLocationFSxWindows(Construct scope, string id, ICfnLocationFSxWindowsProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnLocationFSxWindowsProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

Properties

AttrCmkSecretConfigSecretArn

Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.

public virtual string AttrCmkSecretConfigSecretArn { get; }

Property Value

string

Remarks

CloudformationAttribute: CmkSecretConfig.SecretArn

AttrLocationArn

The ARN of the specified FSx for Windows Server file system location.

public virtual string AttrLocationArn { get; }

Property Value

string

Remarks

CloudformationAttribute: LocationArn

AttrLocationUri

The URI of the specified FSx for Windows Server file system location.

public virtual string AttrLocationUri { get; }

Property Value

string

Remarks

CloudformationAttribute: LocationUri

AttrManagedSecretConfig

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.

public virtual IResolvable AttrManagedSecretConfig { get; }

Property Value

IResolvable

Remarks

DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

CloudformationAttribute: ManagedSecretConfig

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server file system.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server file system.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

CmkSecretConfig

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

public virtual object? CmkSecretConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnLocationFSxWindows.ICmkSecretConfigProperty

CustomSecretConfig

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

public virtual object? CustomSecretConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnLocationFSxWindows.ICustomSecretConfigProperty

Domain

Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.

public virtual string? Domain { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

FsxFilesystemArn

Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

public virtual string? FsxFilesystemArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

LocationFSxWindowsRef

A reference to a LocationFSxWindows resource.

public virtual ILocationFSxWindowsReference LocationFSxWindowsRef { get; }

Property Value

ILocationFSxWindowsReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

Password

Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

public virtual string? Password { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

SecurityGroupArns

The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.

public virtual string[] SecurityGroupArns { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

Subdirectory

Specifies a mount path for your file system using forward slashes.

public virtual string? Subdirectory { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

TagsRaw

Specifies labels that help you categorize, filter, and search for your AWS resources.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

User

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

public virtual string User { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

IsCfnLocationFSxWindows(object)

Checks whether the given object is a CfnLocationFSxWindows.

public static bool IsCfnLocationFSxWindows(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server file system.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxwindows.html

CloudformationResource: AWS::DataSync::LocationFSxWindows

ExampleMetadata: fixture=_generated

Implements

IInspectable

ILocationFSxWindowsRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable