aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,006 lines • 165 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* The `AWS::DataSync::Agent` resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.
*
* The activation process associates the agent with your AWS account .
*
* For more information, see the following topics in the *AWS DataSync User Guide* :
*
* - [DataSync agent requirements](https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html)
* - [DataSync network requirements](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html)
* - [Create a DataSync agent](https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html)
*
* @cloudformationResource AWS::DataSync::Agent
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html
*/
export declare class CfnAgent extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnAgent from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAgent;
/**
* The Amazon Resource Name (ARN) of the agent. Use the `ListAgents` operation to return a list of agents for your account and AWS Region .
*
* @cloudformationAttribute AgentArn
*/
readonly attrAgentArn: string;
/**
* The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.
*
* @cloudformationAttribute EndpointType
*/
readonly attrEndpointType: string;
/**
* Specifies your DataSync agent's activation key.
*/
activationKey?: string;
/**
* Specifies a name for your agent.
*/
agentName?: string;
/**
* The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
*/
securityGroupArns?: Array<string>;
/**
* Specifies the ARN of the subnet where your VPC service endpoint is located.
*/
subnetArns?: Array<string>;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* The ID of the virtual private cloud (VPC) endpoint that the agent has access to.
*/
vpcEndpointId?: string;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props?: CfnAgentProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnAgent`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html
*/
export interface CfnAgentProps {
/**
* Specifies your DataSync agent's activation key.
*
* If you don't have an activation key, see [Activating your agent](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-activationkey
*/
readonly activationKey?: string;
/**
* Specifies a name for your agent.
*
* We recommend specifying a name that you can remember.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-agentname
*/
readonly agentName?: string;
/**
* The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
*
* See [SecurityGroupArns](https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns) .
*
* *Pattern* : `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-securitygrouparns
*/
readonly securityGroupArns?: Array<string>;
/**
* Specifies the ARN of the subnet where your VPC service endpoint is located.
*
* You can only specify one ARN.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-subnetarns
*/
readonly subnetArns?: Array<string>;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*
* We recommend creating at least one tag for your agent.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The ID of the virtual private cloud (VPC) endpoint that the agent has access to.
*
* This is the client-side VPC endpoint, powered by AWS PrivateLink . If you don't have an AWS PrivateLink VPC endpoint, see [AWS PrivateLink and VPC endpoints](https://docs.aws.amazon.com//vpc/latest/userguide/endpoint-services-overview.html) in the *Amazon VPC User Guide* .
*
* For more information about activating your agent in a private network based on a VPC, see [Using AWS DataSync in a Virtual Private Cloud](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-in-vpc.html) in the *AWS DataSync User Guide.*
*
* A VPC endpoint ID looks like this: `vpce-01234d5aff67890e1` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-vpcendpointid
*/
readonly vpcEndpointId?: string;
}
/**
* Creates a transfer *location* for a Microsoft Azure Blob Storage container.
*
* AWS DataSync can use this location as a transfer source or destination.
*
* Before you begin, make sure you know [how DataSync accesses Azure Blob Storage](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access) and works with [access tiers](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) and [blob types](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types) . You also need a [DataSync agent](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent) that can connect to your container.
*
* @cloudformationResource AWS::DataSync::LocationAzureBlob
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html
*/
export declare class CfnLocationAzureBlob extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnLocationAzureBlob from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLocationAzureBlob;
/**
* The ARN of the Azure Blob Storage transfer location that you created.
*
* @cloudformationAttribute LocationArn
*/
readonly attrLocationArn: string;
/**
* The URI of the Azure Blob Storage transfer location that you created.
*
* @cloudformationAttribute LocationUri
*/
readonly attrLocationUri: string;
/**
* Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
*/
agentArns: Array<string>;
/**
* Specifies the access tier that you want your objects or files transferred into.
*/
azureAccessTier?: string;
/**
* Specifies the authentication method DataSync uses to access your Azure Blob Storage.
*/
azureBlobAuthenticationType: string;
/**
* Specifies the URL of the Azure Blob Storage container involved in your transfer.
*/
azureBlobContainerUrl?: string;
/**
* Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
*/
azureBlobSasConfiguration?: CfnLocationAzureBlob.AzureBlobSasConfigurationProperty | cdk.IResolvable;
/**
* Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.
*/
azureBlobType?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, `/my/images` ).
*/
subdirectory?: string;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*/
tags?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnLocationAzureBlobProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnLocationAzureBlob {
/**
* The shared access signature (SAS) configuration that allows AWS DataSync to access your Microsoft Azure Blob Storage.
*
* For more information, see [SAS tokens](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens) for accessing your Azure Blob Storage.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-azureblobsasconfiguration.html
*/
interface AzureBlobSasConfigurationProperty {
/**
* Specifies a SAS token that provides permissions to access your Azure Blob Storage.
*
* The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:
*
* `sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-azureblobsasconfiguration.html#cfn-datasync-locationazureblob-azureblobsasconfiguration-azureblobsastoken
*/
readonly azureBlobSasToken: string;
}
}
/**
* Properties for defining a `CfnLocationAzureBlob`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html
*/
export interface CfnLocationAzureBlobProps {
/**
* Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
*
* You can specify more than one agent. For more information, see [Using multiple agents for your transfer](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-agentarns
*/
readonly agentArns: Array<string>;
/**
* Specifies the access tier that you want your objects or files transferred into.
*
* This only applies when using the location as a transfer destination. For more information, see [Access tiers](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers) .
*
* @default - "HOT"
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureaccesstier
*/
readonly azureAccessTier?: string;
/**
* Specifies the authentication method DataSync uses to access your Azure Blob Storage.
*
* DataSync can access blob storage using a shared access signature (SAS).
*
* @default - "SAS"
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobauthenticationtype
*/
readonly azureBlobAuthenticationType: string;
/**
* Specifies the URL of the Azure Blob Storage container involved in your transfer.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobcontainerurl
*/
readonly azureBlobContainerUrl?: string;
/**
* Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobsasconfiguration
*/
readonly azureBlobSasConfiguration?: CfnLocationAzureBlob.AzureBlobSasConfigurationProperty | cdk.IResolvable;
/**
* Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage.
*
* Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the [Azure Blob Storage documentation](https://docs.aws.amazon.com/https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs) .
*
* @default - "BLOCK"
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobtype
*/
readonly azureBlobType?: string;
/**
* Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, `/my/images` ).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-subdirectory
*/
readonly subdirectory?: string;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*
* We recommend creating at least a name tag for your transfer location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* 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.
*
* @cloudformationResource AWS::DataSync::LocationEFS
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html
*/
export declare class CfnLocationEFS extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnLocationEFS from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLocationEFS;
/**
* The Amazon Resource Name (ARN) of the Amazon EFS file system.
*
* @cloudformationAttribute LocationArn
*/
readonly attrLocationArn: string;
/**
* The URI of the Amazon EFS file system.
*
* @cloudformationAttribute LocationUri
*/
readonly attrLocationUri: string;
/**
* Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.
*/
accessPointArn?: string;
/**
* Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) .
*/
ec2Config: CfnLocationEFS.Ec2ConfigProperty | cdk.IResolvable;
/**
* Specifies the ARN for your Amazon EFS file system.
*/
efsFilesystemArn?: string;
/**
* Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
*/
fileSystemAccessRoleArn?: string;
/**
* Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system.
*/
inTransitEncryption?: string;
/**
* Specifies a mount path for your Amazon EFS file system.
*/
subdirectory?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Specifies the key-value pair that represents a tag that you want to add to the resource.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnLocationEFSProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnLocationEFS {
/**
* The subnet and security groups that AWS DataSync uses to connect to one of your Amazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html
*/
interface Ec2ConfigProperty {
/**
* Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html#cfn-datasync-locationefs-ec2config-securitygrouparns
*/
readonly securityGroupArns: Array<string>;
/**
* Specifies the ARN of a subnet where DataSync creates the [network interfaces](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces) for managing traffic during your transfer.
*
* The subnet must be located:
*
* - In the same virtual private cloud (VPC) as the Amazon EFS file system.
* - In the same Availability Zone as at least one mount target for the Amazon EFS file system.
*
* > You don't need to specify a subnet that includes a file system mount target.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html#cfn-datasync-locationefs-ec2config-subnetarn
*/
readonly subnetArn: string;
}
}
/**
* Properties for defining a `CfnLocationEFS`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html
*/
export interface CfnLocationEFSProps {
/**
* Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.
*
* For more information, see [Accessing restricted file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-accesspointarn
*/
readonly accessPointArn?: string;
/**
* Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-ec2config
*/
readonly ec2Config: CfnLocationEFS.Ec2ConfigProperty | cdk.IResolvable;
/**
* Specifies the ARN for your Amazon EFS file system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-efsfilesystemarn
*/
readonly efsFilesystemArn?: string;
/**
* Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.
*
* For information on creating this role, see [Creating a DataSync IAM role for file system access](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-filesystemaccessrolearn
*/
readonly fileSystemAccessRoleArn?: string;
/**
* Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your 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` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-intransitencryption
*/
readonly inTransitEncryption?: string;
/**
* Specifies a mount path for your Amazon EFS file system.
*
* This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
*
* By default, DataSync uses the root directory (or [access point](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) if you provide one by using `AccessPointArn` ). You can also include subdirectories using forward slashes (for example, `/path/to/folder` ).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-subdirectory
*/
readonly subdirectory?: string;
/**
* 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html#cfn-datasync-locationefs-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* The `AWS::DataSync::LocationFSxLustre` resource specifies an endpoint for an Amazon FSx for Lustre file system.
*
* @cloudformationResource AWS::DataSync::LocationFSxLustre
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html
*/
export declare class CfnLocationFSxLustre extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnLocationFSxLustre from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLocationFSxLustre;
/**
* The ARN of the specified FSx for Lustre file system location.
*
* @cloudformationAttribute LocationArn
*/
readonly attrLocationArn: string;
/**
* The URI of the specified FSx for Lustre file system location.
*
* @cloudformationAttribute LocationUri
*/
readonly attrLocationUri: string;
/**
* Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
*/
fsxFilesystemArn?: string;
/**
* The ARNs of the security groups that are used to configure the FSx for Lustre file system.
*/
securityGroupArns: Array<string>;
/**
* Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
*/
subdirectory?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnLocationFSxLustreProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnLocationFSxLustre`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html
*/
export interface CfnLocationFSxLustreProps {
/**
* Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-fsxfilesystemarn
*/
readonly fsxFilesystemArn?: string;
/**
* The ARNs of the security groups that are used to configure the FSx for Lustre file system.
*
* *Pattern* : `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$`
*
* *Length constraints* : Maximum length of 128.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-securitygrouparns
*/
readonly securityGroupArns: Array<string>;
/**
* Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
*
* When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory ( `/` ).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-subdirectory
*/
readonly subdirectory?: string;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*
* We recommend creating at least a name tag for your location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* 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.
*
* @cloudformationResource AWS::DataSync::LocationFSxONTAP
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html
*/
export declare class CfnLocationFSxONTAP extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnLocationFSxONTAP from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLocationFSxONTAP;
/**
* The ARN of the FSx for ONTAP file system in the specified location.
*
* @cloudformationAttribute FsxFilesystemArn
*/
readonly attrFsxFilesystemArn: string;
/**
* The ARN of the specified location.
*
* @cloudformationAttribute LocationArn
*/
readonly attrLocationArn: string;
/**
* The URI of the specified location.
*
* @cloudformationAttribute LocationUri
*/
readonly attrLocationUri: string;
/**
* Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
*/
protocol?: cdk.IResolvable | CfnLocationFSxONTAP.ProtocolProperty;
/**
* Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system.
*/
securityGroupArns: Array<string>;
/**
* Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
*/
storageVirtualMachineArn: string;
/**
* Specifies a path to the file share in the SVM where you want to transfer data to or from.
*/
subdirectory?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnLocationFSxONTAPProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnLocationFSxONTAP {
/**
* Specifies the data transfer protocol that AWS DataSync uses to access your Amazon FSx file system.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html
*/
interface ProtocolProperty {
/**
* Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine (SVM).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html#cfn-datasync-locationfsxontap-protocol-nfs
*/
readonly nfs?: cdk.IResolvable | CfnLocationFSxONTAP.NFSProperty;
/**
* Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html#cfn-datasync-locationfsxontap-protocol-smb
*/
readonly smb?: cdk.IResolvable | CfnLocationFSxONTAP.SMBProperty;
}
/**
* Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.
*
* For more information, see [Accessing FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access) .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html
*/
interface SMBProperty {
/**
* Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
*
* If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.
*
* If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-domain
*/
readonly domain?: string;
/**
* Specifies how DataSync can access a location using the SMB protocol.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-mountoptions
*/
readonly mountOptions: cdk.IResolvable | CfnLocationFSxONTAP.SmbMountOptionsProperty;
/**
* Specifies the password of a user who has permission to access your SVM.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-password
*/
readonly password: string;
/**
* Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
*
* If you provide a user in your Active Directory, note the following:
*
* - If you're using AWS Directory Service for Microsoft Active Directory , the user must be a member of the AWS Delegated FSx Administrators group.
* - If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
*
* Make sure that the user has the permissions it needs to copy the data you want:
*
* - `SE_TCB_NAME` : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
* - `SE_SECURITY_NAME` : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see [Ownership and permissions-related options](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-user
*/
readonly user: string;
}
/**
* Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.html
*/
interface SmbMountOptionsProperty {
/**
* By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server.
*
* You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.
*
* These are the following options for configuring the SMB version:
*
* - `AUTOMATIC` (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.
*
* This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an `Operation Not Supported` error.
* - `SMB3` : Restricts the protocol negotiation to only SMB version 3.0.2.
* - `SMB2` : Restricts the protocol negotiation to only SMB version 2.1.
* - `SMB2_0` : Restricts the protocol negotiation to only SMB version 2.0.
* - `SMB1` : Restricts the protocol negotiation to only SMB version 1.0.
*
* > The `SMB1` option isn't available when [creating an Amazon FSx for NetApp ONTAP location](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.html#cfn-datasync-locationfsxontap-smbmountoptions-version
*/
readonly version?: string;
}
/**
* Specifies the Network File System (NFS) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.
*
* For more information, see [Accessing FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access) .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.html
*/
interface NFSProperty {
/**
* Specifies how DataSync can access a location using the NFS protocol.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.html#cfn-datasync-locationfsxontap-nfs-mountoptions
*/
readonly mountOptions: cdk.IResolvable | CfnLocationFSxONTAP.NfsMountOptionsProperty;
}
/**
* Specifies how DataSync can access a location using the NFS protocol.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfsmountoptions.html
*/
interface NfsMountOptionsProperty {
/**
* Specifies the NFS version that you want DataSync to use when mounting your NFS share.
*
* If the server refuses to use the version specified, the task fails.
*
* You can specify the following options:
*
* - `AUTOMATIC` (default): DataSync chooses NFS version 4.1.
* - `NFS3` : Stateless protocol version that allows for asynchronous writes on the server.
* - `NFSv4_0` : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
* - `NFSv4_1` : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
*
* > DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfsmountoptions.html#cfn-datasync-locationfsxontap-nfsmountoptions-version
*/
readonly version?: string;
}
}
/**
* Properties for defining a `CfnLocationFSxONTAP`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html
*/
export interface CfnLocationFSxONTAPProps {
/**
* Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-protocol
*/
readonly protocol?: cdk.IResolvable | CfnLocationFSxONTAP.ProtocolProperty;
/**
* 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-securitygrouparns
*/
readonly securityGroupArns: Array<string>;
/**
* Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-storagevirtualmachinearn
*/
readonly storageVirtualMachineArn: string;
/**
* 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](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) in the *Amazon FSx for NetApp ONTAP User Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-subdirectory
*/
readonly subdirectory?: string;
/**
* Specifies labels that help you categorize, filter, and search for your AWS resources.
*
* We recommend creating at least a name tag for your location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html#cfn-datasync-locationfsxontap-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* The `AWS::DataSync::LocationFSxOpenZFS` resource specifies an endpoint for an Amazon FSx for OpenZFS file system.
*
* @cloudformationResource AWS::DataSync::LocationFSxOpenZFS
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxopenzfs.html
*/
export declare class CfnLocationFSxOpenZFS extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnLocationFSxOpenZFS from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLocationFSxOpenZFS;
/**
* The ARN of the specified FSx for OpenZFS file system location.
*
* @cloudformationAttribute LocationArn
*/
readonly attrLocationArn: string;
/**
* The URI of the specified FSx for OpenZFS file system location.
*
* @cloudformationAttribute LocationUri
*/
readonly attrLocationUri: string;
/**
* The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
*/
fsxFilesystemArn?: string;
/**
* The type of protocol that AWS DataSync uses to access your file system.
*/
protocol: cdk.IResolvable | CfnLocationFSxOpenZFS.ProtocolProperty;
/**
* The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
*/
securityGroupArns: Array<string>;
/**
* A subdirectory in the location's path that must begin with `/fsx` .
*/
subdirectory?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* The key-value pair that represents a tag that you want to add to the resource.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnLocationFSxOpenZFSProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnLocationFSxOpenZFS {
/**
* Represents the protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-protocol.html
*/
interface ProtocolProperty {
/**
* Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-protocol.html#cfn-datasync-locationfsxopenzfs-protocol-nfs
*/
readonly nfs?: cdk.IResolvable | CfnLocationFSxOpenZFS.NFSProperty;
}
/**
* Represents the Network File System (NFS) protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-nfs.html
*/
interface NFSProperty {
/**
* Represents the mount options that are available for DataSync to access an NFS location.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-nfs.html#cfn-datasync-locationfsxopenzfs-nfs-mountoptions
*/
readonly mountOptions: cdk.IResolvable | CfnLocationFSxOpenZFS.MountOptionsProperty;
}
/**
* Represents the mount options that are available for DataSync to access a Network File System (NFS) location.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties