@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-datapipeline-pipeline.d.ts

@@ -0,0 +1,138 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataPipelinePipeline = ResourceDefinitionWithAttributes<"AWS::DataPipeline::Pipeline", DataPipelinePipelineProps, DataPipelinePipelineAttribs>;
+/**
+ * The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data.
+ *
+ * > AWS Data Pipeline is no longer available to new customers. Existing customers of AWS Data Pipeline can continue to use the service as normal. [Learn more](https://docs.aws.amazon.com/big-data/migrate-workloads-from-aws-data-pipeline/)
+ *
+ * In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources.
+ *
+ * The `AWS::DataPipeline::Pipeline` resource adds tasks, schedules, and preconditions to the specified pipeline. You can use `PutPipelineDefinition` to populate a new pipeline.
+ *
+ * `PutPipelineDefinition` also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following validation errors exist in the pipeline.
+ *
+ * - An object is missing a name or identifier field.
+ * - A string or reference field is empty.
+ * - The number of objects in the pipeline exceeds the allowed maximum number of objects.
+ * - The pipeline is in a FINISHED state.
+ *
+ * Pipeline object definitions are passed to the [PutPipelineDefinition](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html) action and returned by the [GetPipelineDefinition](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html) action.
+ */
+export type DataPipelinePipelineProps = {
+    /**
+     * Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to `true` .
+     */
+    Activate?: boolean | undefined;
+    /**
+     * A description of the pipeline.
+     */
+    Description?: string | undefined;
+    /**
+     * The name of the pipeline.
+     */
+    Name: string;
+    /**
+     * The parameter objects used with the pipeline.
+     */
+    ParameterObjects?: ParameterObject[] | undefined;
+    /**
+     * The parameter values used with the pipeline.
+     */
+    ParameterValues?: ParameterValue[] | undefined;
+    /**
+     * The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide* .
+     */
+    PipelineObjects?: PipelineObject[] | undefined;
+    /**
+     * A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide* .
+     */
+    PipelineTags?: Tag[] | undefined;
+};
+export type DataPipelinePipelineAttribs = {
+    /**
+     * The ID of the pipeline.
+     */
+    PipelineId: string;
+};
+/**
+ * A key-value pair that describes a property of a `PipelineObject` . The value is specified as either a string value ( `StringValue` ) or a reference to another object ( `RefValue` ) but not as both. To view fields for a data pipeline object, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide* .
+ */
+export type Field = {
+    /**
+     * Specifies the name of a field for a particular object. To view valid values for a particular field, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide* .
+     */
+    Key: string;
+    /**
+     * A field value that you specify as an identifier of another object in the same pipeline definition.
+     *
+     * > You can specify the field value as either a string value ( `StringValue` ) or a reference to another object ( `RefValue` ), but not both.
+     *
+     * Required if the key that you are using requires it.
+     */
+    RefValue?: string | undefined;
+    /**
+     * A field value that you specify as a string. To view valid values for a particular field, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide* .
+     *
+     * > You can specify the field value as either a string value ( `StringValue` ) or a reference to another object ( `RefValue` ), but not both.
+     *
+     * Required if the key that you are using requires it.
+     */
+    StringValue?: string | undefined;
+};
+/**
+ * `Attribute` is a property of `ParameterObject` that defines the attributes of a parameter object as key-value pairs.
+ */
+export type ParameterAttribute = {
+    /**
+     * The field identifier.
+     */
+    Key: string;
+    /**
+     * The field value, expressed as a String.
+     */
+    StringValue: string;
+};
+/**
+ * Contains information about a parameter object.
+ */
+export type ParameterObject = {
+    /**
+     * The attributes of the parameter object.
+     */
+    Attributes: ParameterAttribute[];
+    /**
+     * The ID of the parameter object.
+     */
+    Id: string;
+};
+/**
+ * A value or list of parameter values.
+ */
+export type ParameterValue = {
+    /**
+     * The ID of the parameter value.
+     */
+    Id: string;
+    /**
+     * The field value, expressed as a String.
+     */
+    StringValue: string;
+};
+/**
+ * PipelineObject is property of the AWS::DataPipeline::Pipeline resource that contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.
+ */
+export type PipelineObject = {
+    /**
+     * Key-value pairs that define the properties of the object.
+     */
+    Fields: Field[];
+    /**
+     * The ID of the object.
+     */
+    Id: string;
+    /**
+     * The name of the object.
+     */
+    Name: string;
+};
+//# sourceMappingURL=aws-datapipeline-pipeline.d.ts.map

package/out/exports/resources.generated/aws-datasync-agent.d.ts

@@ -0,0 +1,62 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncAgent = ResourceDefinitionWithAttributes<"AWS::DataSync::Agent", DataSyncAgentProps, DataSyncAgentAttribs>;
+/**
+ * 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)
+ */
+export type DataSyncAgentProps = {
+    /**
+     * 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) .
+     * @maxLength 29
+     * @pattern [A-Z0-9]{5}(-[A-Z0-9]{5}){4}
+     */
+    ActivationKey?: string | undefined;
+    /**
+     * Specifies a name for your agent. We recommend specifying a name that you can remember.
+     * @minLength 0
+     * @maxLength 256
+     * @pattern ^[a-zA-Z0-9\s+=._:@/-]+$
+     */
+    AgentName?: string | undefined;
+    /**
+     * 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/.*$`
+     */
+    SecurityGroupArns?: string[] | undefined;
+    /**
+     * Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.
+     */
+    SubnetArns?: string[] | undefined;
+    /**
+     * Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least one tag for your agent.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * 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` .
+     * @pattern ^vpce-[0-9a-f]{17}$
+     */
+    VpcEndpointId?: string | undefined;
+};
+export type DataSyncAgentAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the agent. Use the `ListAgents` operation to return a list of agents for your account and AWS Region .
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$
+     */
+    AgentArn: 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.
+     */
+    EndpointType: "FIPS" | "PUBLIC" | "PRIVATE_LINK";
+};
+//# sourceMappingURL=aws-datasync-agent.d.ts.map

package/out/exports/resources.generated/aws-datasync-locationazureblob.d.ts

@@ -0,0 +1,83 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationAzureBlob = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationAzureBlob", DataSyncLocationAzureBlobProps, DataSyncLocationAzureBlobAttribs>;
+/**
+ * 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.
+ */
+export type DataSyncLocationAzureBlobProps = {
+    /**
+     * 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) .
+     */
+    AgentArns: 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"
+     */
+    AzureAccessTier?: "HOT" | "COOL" | "ARCHIVE" | undefined;
+    /**
+     * 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"
+     */
+    AzureBlobAuthenticationType: "SAS";
+    /**
+     * Specifies the URL of the Azure Blob Storage container involved in your transfer.
+     * @maxLength 325
+     * @pattern ^https://[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}/[a-z0-9](-?[a-z0-9]){2,62}$
+     */
+    AzureBlobContainerUrl?: string | undefined;
+    /**
+     * Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
+     */
+    AzureBlobSasConfiguration?: AzureBlobSasConfiguration | undefined;
+    /**
+     * 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"
+     */
+    AzureBlobType?: "BLOCK" | undefined;
+    /**
+     * Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, `/my/images` ).
+     * @maxLength 1024
+     * @pattern ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$
+     */
+    Subdirectory?: string | undefined;
+    /**
+     * 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.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type DataSyncLocationAzureBlobAttribs = {
+    /**
+     * The ARN of the Azure Blob Storage transfer location that you created.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
+     */
+    LocationArn: string;
+    /**
+     * The URI of the Azure Blob Storage transfer location that you created.
+     * @maxLength 4356
+     * @pattern ^(azure-blob)://[a-zA-Z0-9./\-]+$
+     */
+    LocationUri: string;
+};
+/**
+ * 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.
+ */
+export type AzureBlobSasConfiguration = {
+    /**
+     * 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`
+     * @minLength 1
+     * @maxLength 255
+     * @pattern (^.+$)
+     */
+    AzureBlobSasToken: string;
+};
+//# sourceMappingURL=aws-datasync-locationazureblob.d.ts.map

package/out/exports/resources.generated/aws-datasync-locationefs.d.ts

@@ -0,0 +1,88 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationEFS = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationEFS", DataSyncLocationEFSProps, DataSyncLocationEFSAttribs>;
+/**
+ * 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.
+ */
+export type DataSyncLocationEFSProps = {
+    /**
+     * 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) .
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$
+     */
+    AccessPointArn?: string | undefined;
+    /**
+     * 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: Ec2Config;
+    /**
+     * Specifies the ARN for your Amazon EFS file system.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$
+     */
+    EfsFilesystemArn?: string | undefined;
+    /**
+     * 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) .
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$
+     */
+    FileSystemAccessRoleArn?: string | undefined;
+    /**
+     * 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` .
+     */
+    InTransitEncryption?: "NONE" | "TLS1_2" | undefined;
+    /**
+     * 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` ).
+     * @maxLength 4096
+     * @pattern ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
+     */
+    Subdirectory?: string | undefined;
+    /**
+     * 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.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type DataSyncLocationEFSAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the Amazon EFS file system.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
+     */
+    LocationArn: string;
+    /**
+     * The URI of the Amazon EFS file system.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\-/]+$
+     */
+    LocationUri: string;
+};
+/**
+ * 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) .
+ */
+export type Ec2Config = {
+    /**
+     * Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.
+     */
+    SecurityGroupArns: 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.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$
+     */
+    SubnetArn: string;
+};
+//# sourceMappingURL=aws-datasync-locationefs.d.ts.map

package/out/exports/resources.generated/aws-datasync-locationfsxlustre.d.ts

@@ -0,0 +1,48 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationFSxLustre = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationFSxLustre", DataSyncLocationFSxLustreProps, DataSyncLocationFSxLustreAttribs>;
+/**
+ * The `AWS::DataSync::LocationFSxLustre` resource specifies an endpoint for an Amazon FSx for Lustre file system.
+ */
+export type DataSyncLocationFSxLustreProps = {
+    /**
+     * Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$
+     */
+    FsxFilesystemArn?: string | undefined;
+    /**
+     * 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.
+     */
+    SecurityGroupArns: 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 ( `/` ).
+     * @maxLength 4096
+     * @pattern ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
+     */
+    Subdirectory?: string | undefined;
+    /**
+     * Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type DataSyncLocationFSxLustreAttribs = {
+    /**
+     * The ARN of the specified FSx for Lustre file system location.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
+     */
+    LocationArn: string;
+    /**
+     * The URI of the specified FSx for Lustre file system location.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw|hdfs|fsxl)://[a-zA-Z0-9.:/\-]+$
+     */
+    LocationUri: string;
+};
+//# sourceMappingURL=aws-datasync-locationfsxlustre.d.ts.map

package/out/exports/resources.generated/aws-datasync-locationfsxontap.d.ts

@@ -0,0 +1,163 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationFSxONTAP = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationFSxONTAP", DataSyncLocationFSxONTAPProps, DataSyncLocationFSxONTAPAttribs>;
+/**
+ * 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.
+ */
+export type DataSyncLocationFSxONTAPProps = {
+    /**
+     * Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
+     */
+    Protocol?: Protocol | undefined;
+    /**
+     * 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.
+     */
+    SecurityGroupArns: string[];
+    /**
+     * Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
+     * @maxLength 162
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$
+     */
+    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* .
+     * @maxLength 4096
+     * @pattern ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
+     */
+    Subdirectory?: string | undefined;
+    /**
+     * Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type DataSyncLocationFSxONTAPAttribs = {
+    /**
+     * The ARN of the FSx for ONTAP file system in the specified location.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$
+     */
+    FsxFilesystemArn: string;
+    /**
+     * The ARN of the specified location.
+     * @maxLength 128
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
+     */
+    LocationArn: string;
+    /**
+     * The URI of the specified location.
+     * @maxLength 4360
+     * @pattern ^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$
+     */
+    LocationUri: 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) .
+ */
+export type NFS = {
+    /**
+     * Specifies how DataSync can access a location using the NFS protocol.
+     */
+    MountOptions: NfsMountOptions;
+};
+/**
+ * Specifies how DataSync can access a location using the NFS protocol.
+ */
+export type NfsMountOptions = {
+    /**
+     * 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.
+     */
+    Version?: "AUTOMATIC" | "NFS3" | "NFS4_0" | "NFS4_1" | undefined;
+};
+/**
+ * Specifies the data transfer protocol that AWS DataSync uses to access your Amazon FSx file system.
+ */
+export type Protocol = {
+    /**
+     * Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine (SVM).
+     */
+    NFS?: NFS | undefined;
+    /**
+     * Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
+     */
+    SMB?: SMB | undefined;
+};
+/**
+ * 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) .
+ */
+export type SMB = {
+    /**
+     * 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.
+     * @maxLength 253
+     * @pattern ^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$
+     */
+    Domain?: string | undefined;
+    /**
+     * Specifies how DataSync can access a location using the SMB protocol.
+     */
+    MountOptions: SmbMountOptions;
+    /**
+     * Specifies the password of a user who has permission to access your SVM.
+     * @maxLength 104
+     * @pattern ^.{0,104}$
+     */
+    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) .
+     * @maxLength 104
+     * @pattern ^[^\x5B\x5D\\/:;|=,+*?]{1,104}$
+     */
+    User: string;
+};
+/**
+ * Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.
+ */
+export type SmbMountOptions = {
+    /**
+     * 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) .
+     */
+    Version?: "AUTOMATIC" | "SMB2" | "SMB3" | undefined;
+};
+//# sourceMappingURL=aws-datasync-locationfsxontap.d.ts.map