Package com.pulumi.aws.dms

Class S3EndpointArgs

  • public final class S3EndpointArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • addColumnName

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> addColumnName()
        Returns:
        Whether to add column name information to the `.csv` output file. Default is `false`.

      • addTrailingPaddingCharacter

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> addTrailingPaddingCharacter()
        Returns:
        Whether to add padding. Default is `false`. (Ignored for source endpoints.)

      • bucketFolder

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucketFolder()
        Returns:
        S3 object prefix.

      • bucketName

        public com.pulumi.core.Output<java.lang.String> bucketName()
        Returns:
        S3 bucket name.

      • cannedAclForObjects

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cannedAclForObjects()
        Returns:
        Predefined (canned) access control list for objects created in an S3 bucket. Valid values include `none`, `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Default is `none`.

      • cdcInsertsAndUpdates

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> cdcInsertsAndUpdates()
        Returns:
        Whether to write insert and update operations to `.csv` or .parquet output files. Default is `false`.

      • cdcInsertsOnly

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> cdcInsertsOnly()
        Returns:
        Whether to write insert operations to `.csv` or .parquet output files. Default is `false`.

      • cdcMaxBatchInterval

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> cdcMaxBatchInterval()
        Returns:
        Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. (AWS default is `60`.)

      • cdcMinFileSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> cdcMinFileSize()
        Returns:
        Minimum file size condition as defined in kilobytes to output a file to Amazon S3. (AWS default is 32000 KB.)

      • cdcPath

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cdcPath()
        Returns:
        Folder path of CDC files. If `cdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. Supported in AWS DMS versions 3.4.2 and later. Required for CDC.

      • certificateArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> certificateArn()
        Returns:
        ARN for the certificate.

      • compressionType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> compressionType()
        Returns:
        Set to compress target files. Valid values are `GZIP` and `NONE`. Default is `NONE`. (Ignored for source endpoints.)

      • csvDelimiter

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> csvDelimiter()
        Returns:
        Delimiter used to separate columns in the source files. Default is `,`.

      • csvNoSupValue

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> csvNoSupValue()
        Returns:
        Only applies if output files for a CDC load are written in `.csv` format. If `useCsvNoSupValue` is set to `true`, string to use for all columns not included in the supplemental log. If you do not specify a string value, DMS uses the null value for these columns regardless of `useCsvNoSupValue`. (Ignored for source endpoints.)

      • csvNullValue

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> csvNullValue()
        Returns:
        String to as null when writing to the target. (AWS default is `NULL`.)

      • csvRowDelimiter

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> csvRowDelimiter()
        Returns:
        Delimiter used to separate rows in the source files. Default is newline (_i.e._, `\n`).

      • dataFormat

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dataFormat()
        Returns:
        Output format for the files that AWS DMS uses to create S3 objects. Valid values are `csv` and `parquet`. (Ignored for source endpoints -- only `csv` is valid.)

      • dataPageSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> dataPageSize()
        Returns:
        Size of one data page in bytes. (AWS default is 1 MiB, _i.e._, `1048576`.)

      • datePartitionDelimiter

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> datePartitionDelimiter()
        Returns:
        Date separating delimiter to use during folder partitioning. Valid values are `SLASH`, `UNDERSCORE`, `DASH`, and `NONE`. (AWS default is `SLASH`.) (Ignored for source endpoints.)

      • datePartitionEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> datePartitionEnabled()
        Returns:
        Partition S3 bucket folders based on transaction commit dates. Default is `false`. (Ignored for source endpoints.)

      • datePartitionSequence

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> datePartitionSequence()
        Returns:
        Date format to use during folder partitioning. Use this parameter when `datePartitionEnabled` is set to true. Valid values are `YYYYMMDD`, `YYYYMMDDHH`, `YYYYMM`, `MMYYYYDD`, and `DDMMYYYY`. (AWS default is `YYYYMMDD`.) (Ignored for source endpoints.)

      • datePartitionTimezone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> datePartitionTimezone()
        Returns:
        Convert the current UTC time to a timezone. The conversion occurs when a date partition folder is created and a CDC filename is generated. The timezone format is Area/Location (_e.g._, `Europe/Paris`). Use this when `datePartitionEnabled` is `true`. (Ignored for source endpoints.)

      • detachTargetOnLobLookupFailureParquet

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> detachTargetOnLobLookupFailureParquet()
        Returns:
        Undocumented argument for use as directed by AWS Support.

      • dictPageSizeLimit

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> dictPageSizeLimit()
        Returns:
        Maximum size in bytes of an encoded dictionary page of a column. (AWS default is 1 MiB, _i.e._, `1048576`.)

      • enableStatistics

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableStatistics()
        Returns:
        Whether to enable statistics for Parquet pages and row groups. Default is `true`.

      • encodingType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> encodingType()
        Returns:
        Type of encoding to use. Value values are `rle-dictionary`, `plain`, and `plain-dictionary`. (AWS default is `rle-dictionary`.)

      • encryptionMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> encryptionMode()
        Returns:
        Server-side encryption mode that you want to encrypt your `.csv` or .parquet object files copied to S3. Valid values are `SSE_S3` and `SSE_KMS`. (AWS default is `SSE_S3`.) (Ignored for source endpoints -- only `SSE_S3` is valid.)

      • endpointId

        public com.pulumi.core.Output<java.lang.String> endpointId()
        Returns:
        Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens.

      • endpointType

        public com.pulumi.core.Output<java.lang.String> endpointType()
        Returns:
        Type of endpoint. Valid values are `source`, `target`.

      • expectedBucketOwner

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> expectedBucketOwner()
        Returns:
        Bucket owner to prevent sniping. Value is an AWS account ID.

      • externalTableDefinition

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> externalTableDefinition()
        Returns:
        JSON document that describes how AWS DMS should interpret the data. Required for `source` endpoints.

      • glueCatalogGeneration

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> glueCatalogGeneration()
        Returns:
        Whether to integrate AWS Glue Data Catalog with an Amazon S3 target. See [Using AWS Glue Data Catalog with an Amazon S3 target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.GlueCatalog) for more information. Default is `false`.

      • ignoreHeaderRows

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> ignoreHeaderRows()
        Returns:
        When this value is set to `1`, DMS ignores the first row header in a `.csv` file. (AWS default is `0`.)

      • includeOpForFullLoad

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> includeOpForFullLoad()
        Returns:
        Whether to enable a full load to write INSERT operations to the `.csv` output files only to indicate how the rows were added to the source database. Default is `false`.

      • kmsKeyArn

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
        Deprecated.
        kms_key_arn is deprecated. Use serverSideEncryptionKmsKeyId instead.
        Returns:
        ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kmsKeyArn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

      • maxFileSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxFileSize()
        Returns:
        Maximum size (in KB) of any `.csv` file to be created while migrating to an S3 target during full load. Valid values are from `1` to `1048576`. (AWS default is 1 GB, _i.e._, `1048576`.)

      • parquetTimestampInMillisecond

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> parquetTimestampInMillisecond()
        Returns:
        Specifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default is `false`. (Ignored for source endpoints.)

      • parquetVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> parquetVersion()
        Returns:
        Version of the .parquet file format. Valid values are `parquet-1-0` and `parquet-2-0`. (AWS default is `parquet-1-0`.) (Ignored for source endpoints.)

      • preserveTransactions

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> preserveTransactions()
        Returns:
        Whether DMS saves the transaction order for a CDC load on the S3 target specified by `cdcPath`. Default is `false`. (Ignored for source endpoints.)

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • rfc4180

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> rfc4180()
        Returns:
        For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default is `true`.

      • rowGroupLength

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> rowGroupLength()
        Returns:
        Number of rows in a row group. (AWS default is `10000`.)

      • serverSideEncryptionKmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> serverSideEncryptionKmsKeyId()
        Returns:
        When `encryptionMode` is `SSE_KMS`, ARN for the AWS KMS key. (Ignored for source endpoints -- only `SSE_S3` `encryptionMode` is valid.)

      • serviceAccessRoleArn

        public com.pulumi.core.Output<java.lang.String> serviceAccessRoleArn()
        Returns:
        ARN of the IAM role with permissions to the S3 Bucket. The following arguments are optional:

      • sslMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> sslMode()
        Returns:
        SSL mode to use for the connection. Valid values are `none`, `require`, `verify-ca`, `verify-full`. (AWS default is `none`.)

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • timestampColumnName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> timestampColumnName()
        Returns:
        Column to add with timestamp information to the endpoint data for an Amazon S3 target.

      • useCsvNoSupValue

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> useCsvNoSupValue()
        Returns:
        Whether to use `csvNoSupValue` for columns not included in the supplemental log. (Ignored for source endpoints.)

      • useTaskStartTimeForFullLoadTimestamp

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> useTaskStartTimeForFullLoadTimestamp()
        Returns:
        When set to `true`, uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when set to `true`, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time.When set to false, the full load timestamp in the timestamp column increments with the time data arrives at the target. Default is `false`.