Package software.amazon.awssdk.services.ec2.model

Class CreateCapacityManagerDataExportRequest

    • Method Detail

      • s3BucketName

        public final String s3BucketName()

        The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it.

        Returns:
        The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it.

      • s3BucketPrefix

        public final String s3BucketPrefix()

        The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root.

        Returns:
        The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root.

      • schedule

        public final Schedule schedule()

        The frequency at which data exports are generated.

        If the service returns an enum value that is not available in the current SDK version, schedule will return Schedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleAsString().

        Returns:
        The frequency at which data exports are generated.
        See Also:
        Schedule

      • scheduleAsString

        public final String scheduleAsString()

        The frequency at which data exports are generated.

        If the service returns an enum value that is not available in the current SDK version, schedule will return Schedule.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleAsString().

        Returns:
        The frequency at which data exports are generated.
        See Also:
        Schedule

      • outputFormat

        public final OutputFormat outputFormat()

        The file format for the exported data. Parquet format is recommended for large datasets and better compression.

        If the service returns an enum value that is not available in the current SDK version, outputFormat will return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

        Returns:
        The file format for the exported data. Parquet format is recommended for large datasets and better compression.
        See Also:
        OutputFormat

      • outputFormatAsString

        public final String outputFormatAsString()

        The file format for the exported data. Parquet format is recommended for large datasets and better compression.

        If the service returns an enum value that is not available in the current SDK version, outputFormat will return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

        Returns:
        The file format for the exported data. Parquet format is recommended for large datasets and better compression.
        See Also:
        OutputFormat

      • clientToken

        public final String clientToken()

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

        Returns:
        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

      • dryRun

        public final Boolean dryRun()

        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

        Returns:
        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      • hasTagSpecifications

        public final boolean hasTagSpecifications()
        For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tagSpecifications

        public final List<TagSpecification> tagSpecifications()

        The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

        Returns:
        The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object