@propulsionworks/cloudformation 0.0.1 → 0.1.0

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

@@ -0,0 +1,83 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationFSxOpenZFS = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationFSxOpenZFS", DataSyncLocationFSxOpenZFSProps, DataSyncLocationFSxOpenZFSAttribs>;
+/**
+ * The `AWS::DataSync::LocationFSxOpenZFS` resource specifies an endpoint for an Amazon FSx for OpenZFS file system.
+ */
+export type DataSyncLocationFSxOpenZFSProps = {
+    /**
+     * The Amazon Resource Name (ARN) of the FSx for OpenZFS 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 type of protocol that AWS DataSync uses to access your file system.
+     */
+    Protocol: Protocol;
+    /**
+     * The ARNs of the security groups that are used to configure the FSx for OpenZFS 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[];
+    /**
+     * A subdirectory in the location's path that must begin with `/fsx` . DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).
+     * @maxLength 4096
+     * @pattern ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
+     */
+    Subdirectory?: string | undefined;
+    /**
+     * 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 DataSyncLocationFSxOpenZFSAttribs = {
+    /**
+     * The ARN of the specified FSx for OpenZFS 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 OpenZFS file system location.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw|hdfs|fsxl|fsxz)://[a-zA-Z0-9.:/\-]+$
+     */
+    LocationUri: string;
+};
+/**
+ * Represents the mount options that are available for DataSync to access a Network File System (NFS) location.
+ */
+export type MountOptions = {
+    /**
+     * The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to `AUTOMATIC` . That is, DataSync automatically selects a version based on negotiation with the NFS server.
+     *
+     * You can specify the following NFS versions:
+     *
+     * - *[NFSv3](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc1813)* : Stateless protocol version that allows for asynchronous writes on the server.
+     * - *[NFSv4.0](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc3530)* : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
+     * - *[NFSv4.1](https://docs.aws.amazon.com/https://tools.ietf.org/html/rfc5661)* : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.
+     */
+    Version?: "AUTOMATIC" | "NFS3" | "NFS4_0" | "NFS4_1" | undefined;
+};
+/**
+ * Represents the Network File System (NFS) protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.
+ */
+export type NFS = {
+    /**
+     * Represents the mount options that are available for DataSync to access an NFS location.
+     */
+    MountOptions: MountOptions;
+};
+/**
+ * Represents the protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.
+ */
+export type Protocol = {
+    /**
+     * Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.
+     */
+    NFS?: NFS | undefined;
+};
+//# sourceMappingURL=aws-datasync-locationfsxopenzfs.d.ts.map

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

@@ -0,0 +1,68 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationFSxWindows = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationFSxWindows", DataSyncLocationFSxWindowsProps, DataSyncLocationFSxWindowsAttribs>;
+/**
+ * The `AWS::DataSync::LocationFSxWindows` resource specifies an endpoint for an Amazon FSx for Windows Server file system.
+ */
+export type DataSyncLocationFSxWindowsProps = {
+    /**
+     * Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.
+     *
+     * If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
+     * @maxLength 253
+     * @pattern ^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$
+     */
+    Domain?: string | undefined;
+    /**
+     * Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server 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-.*$
+     */
+    FsxFilesystemArn?: string | undefined;
+    /**
+     * 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.
+     * @maxLength 104
+     * @pattern ^.{0,104}$
+     */
+    Password?: string | undefined;
+    /**
+     * The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server 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 file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
+     * @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;
+    /**
+     * The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
+     *
+     * For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see [user](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#FSxWuser) .
+     * @maxLength 104
+     * @pattern ^[^\x5B\x5D\\/:;|=,+*?]{1,104}$
+     */
+    User: string;
+};
+export type DataSyncLocationFSxWindowsAttribs = {
+    /**
+     * The ARN of the specified FSx for Windows Server 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 Windows Server file system location.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\-]+$
+     */
+    LocationUri: string;
+};
+//# sourceMappingURL=aws-datasync-locationfsxwindows.d.ts.map

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

@@ -0,0 +1,130 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationHDFS = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationHDFS", DataSyncLocationHDFSProps, DataSyncLocationHDFSAttribs>;
+/**
+ * The `AWS::DataSync::LocationHDFS` resource specifies an endpoint for a Hadoop Distributed File System (HDFS).
+ */
+export type DataSyncLocationHDFSProps = {
+    /**
+     * The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
+     */
+    AgentArns: string[];
+    /**
+     * The authentication mode used to determine identity of user.
+     */
+    AuthenticationType: "SIMPLE" | "KERBEROS";
+    /**
+     * The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).
+     * @min 1048576
+     * @max 1073741824
+     * @format int64
+     */
+    BlockSize?: number | undefined;
+    /**
+     * The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. Provide the base64-encoded file text. If `KERBEROS` is specified for `AuthType` , this value is required.
+     * @maxLength 87384
+     */
+    KerberosKeytab?: string | undefined;
+    /**
+     * The `krb5.conf` file that contains the Kerberos configuration information. You can load the `krb5.conf` by providing a string of the file's contents or an Amazon S3 presigned URL of the file. If `KERBEROS` is specified for `AuthType` , this value is required.
+     * @maxLength 174764
+     */
+    KerberosKrb5Conf?: string | undefined;
+    /**
+     * The Kerberos principal with access to the files and folders on the HDFS cluster.
+     *
+     * > If `KERBEROS` is specified for `AuthenticationType` , this parameter is required.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^.+$
+     */
+    KerberosPrincipal?: string | undefined;
+    /**
+     * The URI of the HDFS cluster's Key Management Server (KMS).
+     * @minLength 1
+     * @maxLength 255
+     * @pattern ^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$
+     */
+    KmsKeyProviderUri?: string | undefined;
+    /**
+     * The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.
+     */
+    NameNodes: NameNode[];
+    /**
+     * The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If `QopConfiguration` isn't specified, `RpcProtection` and `DataTransferProtection` default to `PRIVACY` . If you set `RpcProtection` or `DataTransferProtection` , the other parameter assumes the same value.
+     */
+    QopConfiguration?: QopConfiguration | undefined;
+    /**
+     * The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.
+     * @min 1
+     * @max 512
+     * @format int64
+     * @default 3
+     */
+    ReplicationFactor?: number | undefined;
+    /**
+     * The user name used to identify the client on the host operating system.
+     *
+     * > If `SIMPLE` is specified for `AuthenticationType` , this parameter is required.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^[_.A-Za-z0-9][-_.A-Za-z0-9]*$
+     */
+    SimpleUser?: string | undefined;
+    /**
+     * A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to `/` .
+     * @maxLength 4096
+     * @pattern ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
+     */
+    Subdirectory?: string | undefined;
+    /**
+     * The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type DataSyncLocationHDFSAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
+     * @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 HDFS cluster location.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw|hdfs)://[a-zA-Z0-9.:/\-]+$
+     */
+    LocationUri: string;
+};
+/**
+ * The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's namespace and performs operations such as opening, closing, and renaming files and directories. The NameNode also contains the information to map blocks of data to the DataNodes.
+ */
+export type NameNode = {
+    /**
+     * The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.
+     * @maxLength 255
+     * @pattern ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$
+     */
+    Hostname: string;
+    /**
+     * The port that the NameNode uses to listen to client requests.
+     * @min 1
+     * @max 65536
+     */
+    Port: number;
+};
+/**
+ * The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
+ */
+export type QopConfiguration = {
+    /**
+     * The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your `dfs.data.transfer.protection` setting in the `hdfs-site.xml` file on your Hadoop cluster.
+     * @default "PRIVACY"
+     */
+    DataTransferProtection?: "AUTHENTICATION" | "INTEGRITY" | "PRIVACY" | "DISABLED" | undefined;
+    /**
+     * The Remote Procedure Call (RPC) protection setting configured on the HDFS cluster. This setting corresponds to your `hadoop.rpc.protection` setting in your `core-site.xml` file on your Hadoop cluster.
+     * @default "PRIVACY"
+     */
+    RpcProtection?: "AUTHENTICATION" | "INTEGRITY" | "PRIVACY" | "DISABLED" | undefined;
+};
+//# sourceMappingURL=aws-datasync-locationhdfs.d.ts.map

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

@@ -0,0 +1,80 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationNFS = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationNFS", DataSyncLocationNFSProps, DataSyncLocationNFSAttribs>;
+/**
+ * The `AWS::DataSync::LocationNFS` resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination.
+ */
+export type DataSyncLocationNFSProps = {
+    /**
+     * Specifies the options that DataSync can use to mount your NFS file server.
+     * @default {"Version":"AUTOMATIC"}
+     */
+    MountOptions?: MountOptions | undefined;
+    /**
+     * Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server.
+     *
+     * You can specify more than one agent. For more information, see [Using multiple DataSync agents](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents) .
+     */
+    OnPremConfig: OnPremConfig;
+    /**
+     * Specifies the DNS name or IP version 4 address of the NFS file server that your DataSync agent connects to.
+     * @maxLength 255
+     * @pattern ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$
+     */
+    ServerHostname?: string | undefined;
+    /**
+     * Specifies the export path in your NFS file server that you want DataSync to mount.
+     *
+     * This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see [Accessing NFS file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs) .
+     * @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 DataSyncLocationNFSAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the NFS 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 NFS location that you created.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\-]+$
+     */
+    LocationUri: string;
+};
+/**
+ * Specifies the options that DataSync can use to mount your NFS file server.
+ */
+export type MountOptions = {
+    /**
+     * 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;
+};
+/**
+ * The AWS DataSync agents that can connect to your Network File System (NFS) file server.
+ */
+export type OnPremConfig = {
+    /**
+     * The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.
+     *
+     * You can specify more than one agent. For more information, see [Using multiple DataSync agents](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents) .
+     */
+    AgentArns: string[];
+};
+//# sourceMappingURL=aws-datasync-locationnfs.d.ts.map

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

@@ -0,0 +1,90 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationObjectStorage = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationObjectStorage", DataSyncLocationObjectStorageProps, DataSyncLocationObjectStorageAttribs>;
+/**
+ * The `AWS::DataSync::LocationObjectStorage` resource specifies an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see [Creating a Location for Object Storage](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html) .
+ */
+export type DataSyncLocationObjectStorageProps = {
+    /**
+     * Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
+     * @minLength 1
+     * @maxLength 200
+     * @pattern ^.+$
+     */
+    AccessKey?: string | undefined;
+    /**
+     * Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
+     */
+    AgentArns: string[];
+    /**
+     * Specifies the name of the object storage bucket involved in the transfer.
+     * @minLength 3
+     * @maxLength 63
+     * @pattern ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
+     */
+    BucketName?: string | undefined;
+    /**
+     * Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
+     * @minLength 8
+     * @maxLength 200
+     * @pattern ^.+$
+     */
+    SecretKey?: string | undefined;
+    /**
+     * Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single `.pem` file with a full certificate chain (for example, `file:///home/user/.ssh/object_storage_certificates.pem` ).
+     *
+     * The certificate chain might include:
+     *
+     * - The object storage system's certificate
+     * - All intermediate certificates (if there are any)
+     * - The root certificate of the signing CA
+     *
+     * You can concatenate your certificates into a `.pem` file (which can be up to 32768 bytes before base64 encoding). The following example `cat` command creates an `object_storage_certificates.pem` file that includes three certificates:
+     *
+     * `cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`
+     *
+     * To use this parameter, configure `ServerProtocol` to `HTTPS` .
+     * @maxLength 32768
+     */
+    ServerCertificate?: string | undefined;
+    /**
+     * Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.
+     * @maxLength 255
+     * @pattern ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$
+     */
+    ServerHostname?: string | undefined;
+    /**
+     * Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
+     * @min 1
+     * @max 65536
+     */
+    ServerPort?: number | undefined;
+    /**
+     * Specifies the protocol that your object storage server uses to communicate.
+     */
+    ServerProtocol?: "HTTPS" | "HTTP" | undefined;
+    /**
+     * Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
+     * @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. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type DataSyncLocationObjectStorageAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the specified object storage 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 object storage location.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw|object-storage)://[a-zA-Z0-9./\-]+$
+     */
+    LocationUri: string;
+};
+//# sourceMappingURL=aws-datasync-locationobjectstorage.d.ts.map

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

@@ -0,0 +1,73 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationS3 = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationS3", DataSyncLocationS3Props, DataSyncLocationS3Attribs>;
+/**
+ * The `AWS::DataSync::LocationS3` resource specifies an endpoint for an Amazon S3 bucket.
+ *
+ * For more information, see the [*AWS DataSync User Guide*](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html) .
+ */
+export type DataSyncLocationS3Props = {
+    /**
+     * The ARN of the Amazon S3 bucket.
+     * @maxLength 156
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]*:.*$
+     */
+    S3BucketArn?: string | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
+     *
+     * For detailed information about using such a role, see [Creating a Location for Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location) in the *AWS DataSync User Guide* .
+     */
+    S3Config: S3Config;
+    /**
+     * The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in AWS Regions , the storage class defaults to S3 Standard.
+     *
+     * For more information about S3 storage classes, see [Amazon S3 Storage Classes](https://docs.aws.amazon.com/s3/storage-classes/) . Some storage classes have behaviors that can affect your S3 storage costs. For detailed information, see [Considerations When Working with Amazon S3 Storage Classes in DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) .
+     * @default "STANDARD"
+     */
+    S3StorageClass?: "STANDARD" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "GLACIER_INSTANT_RETRIEVAL" | "DEEP_ARCHIVE" | undefined;
+    /**
+     * Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).
+     *
+     * > DataSync can't transfer objects with a prefix that begins with a slash ( `/` ) or includes `//` , `/./` , or `/../` patterns. For example:
+     * >
+     * > - `/photos`
+     * > - `photos//2006/January`
+     * > - `photos/./2006/February`
+     * > - `photos/../2006/March`
+     * @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 DataSyncLocationS3Attribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the specified Amazon S3 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 Amazon S3 location.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\-/]+$
+     */
+    LocationUri: string;
+};
+/**
+ * Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
+ *
+ * For more information, see [Providing DataSync access to S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access) .
+ */
+export type S3Config = {
+    /**
+     * Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.
+     * @maxLength 2048
+     * @pattern ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$
+     */
+    BucketAccessRoleArn: string;
+};
+//# sourceMappingURL=aws-datasync-locations3.d.ts.map

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

@@ -0,0 +1,137 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type DataSyncLocationSMB = ResourceDefinitionWithAttributes<"AWS::DataSync::LocationSMB", DataSyncLocationSMBProps, DataSyncLocationSMBAttribs>;
+/**
+ * The `AWS::DataSync::LocationSMB` resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.
+ */
+export type DataSyncLocationSMBProps = {
+    /**
+     * Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
+     */
+    AgentArns: string[];
+    /**
+     * Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports `NTLM` (default) and `KERBEROS` authentication.
+     *
+     * For more information, see [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) .
+     */
+    AuthenticationType?: "NTLM" | "KERBEROS" | undefined;
+    /**
+     * Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if `AuthenticationType` is set to `KERBEROS` .
+     *
+     * If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
+     * @default null
+     */
+    DnsIpAddresses?: string[] | undefined;
+    /**
+     * Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if `AuthenticationType` is set to `NTLM` .
+     *
+     * If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
+     * @maxLength 253
+     * @pattern ^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$
+     */
+    Domain?: string | undefined;
+    /**
+     * Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
+     *
+     * The file must be base64 encoded.
+     *
+     * To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for `KerberosPrincipal` .
+     * @maxLength 87384
+     */
+    KerberosKeytab?: string | undefined;
+    /**
+     * Specifies a Kerberos configuration file ( `krb5.conf` ) that defines your Kerberos realm configuration.
+     *
+     * The file must be base64 encoded.
+     * @maxLength 174764
+     */
+    KerberosKrb5Conf?: string | undefined;
+    /**
+     * Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
+     *
+     * A Kerberos principal might look like `HOST/kerberosuser@MYDOMAIN.ORG` .
+     *
+     * Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^.+$
+     */
+    KerberosPrincipal?: string | undefined;
+    /**
+     * Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
+     * @default {"Version":"AUTOMATIC"}
+     */
+    MountOptions?: MountOptions | undefined;
+    /**
+     * Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if `AuthenticationType` is set to `NTLM` .
+     * @maxLength 104
+     * @pattern ^.{0,104}$
+     */
+    Password?: string | undefined;
+    /**
+     * Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.
+     *
+     * Remember the following when configuring this parameter:
+     *
+     * - You can't specify an IP version 6 (IPv6) address.
+     * - If you're using Kerberos authentication, you must specify a domain name.
+     * @maxLength 255
+     * @pattern ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$
+     */
+    ServerHostname?: string | undefined;
+    /**
+     * Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, `/path/to/subdirectory` ). Make sure that other SMB clients in your network can also mount this path.
+     *
+     * To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) .
+     * @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;
+    /**
+     * Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if `AuthenticationType` is set to `NTLM` .
+     *
+     * For information about choosing a user with the right level of access for your transfer, see [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) .
+     * @maxLength 104
+     * @pattern ^[^\x5B\x5D\\/:;|=,+*?]{1,104}$
+     */
+    User?: string | undefined;
+};
+export type DataSyncLocationSMBAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the specified SMB 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 SMB location.
+     * @maxLength 4356
+     * @pattern ^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9./\-]+$
+     */
+    LocationUri: string;
+};
+/**
+ * Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
+ */
+export type MountOptions = {
+    /**
+     * 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" | "SMB1" | "SMB2_0" | "SMB2" | "SMB3" | undefined;
+};
+//# sourceMappingURL=aws-datasync-locationsmb.d.ts.map