Interface ExportTableToPointInTimeRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ExportTableToPointInTimeRequest.Builder,ExportTableToPointInTimeRequest>,DynamoDbRequest.Builder,SdkBuilder<ExportTableToPointInTimeRequest.Builder,ExportTableToPointInTimeRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ExportTableToPointInTimeRequest
@Mutable @NotThreadSafe public static interface ExportTableToPointInTimeRequest.Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<ExportTableToPointInTimeRequest.Builder,ExportTableToPointInTimeRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ExportTableToPointInTimeRequest.BuilderclientToken(String clientToken)Providing aClientTokenmakes the call toExportTableToPointInTimeInputidempotent, meaning that multiple identical calls have the same effect as one single call.ExportTableToPointInTimeRequest.BuilderexportFormat(String exportFormat)The format for the exported data.ExportTableToPointInTimeRequest.BuilderexportFormat(ExportFormat exportFormat)The format for the exported data.ExportTableToPointInTimeRequest.BuilderexportTime(Instant exportTime)Time in the past from which to export table data, counted in seconds from the start of the Unix epoch.ExportTableToPointInTimeRequest.BuilderexportType(String exportType)Choice of whether to execute as a full export or incremental export.ExportTableToPointInTimeRequest.BuilderexportType(ExportType exportType)Choice of whether to execute as a full export or incremental export.default ExportTableToPointInTimeRequest.BuilderincrementalExportSpecification(Consumer<IncrementalExportSpecification.Builder> incrementalExportSpecification)Optional object containing the parameters specific to an incremental export.ExportTableToPointInTimeRequest.BuilderincrementalExportSpecification(IncrementalExportSpecification incrementalExportSpecification)Optional object containing the parameters specific to an incremental export.ExportTableToPointInTimeRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ExportTableToPointInTimeRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ExportTableToPointInTimeRequest.Builders3Bucket(String s3Bucket)The name of the Amazon S3 bucket to export the snapshot to.ExportTableToPointInTimeRequest.Builders3BucketOwner(String s3BucketOwner)The ID of the Amazon Web Services account that owns the bucket the export will be stored in.ExportTableToPointInTimeRequest.Builders3Prefix(String s3Prefix)The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.ExportTableToPointInTimeRequest.Builders3SseAlgorithm(String s3SseAlgorithm)Type of encryption used on the bucket where export data will be stored.ExportTableToPointInTimeRequest.Builders3SseAlgorithm(S3SseAlgorithm s3SseAlgorithm)Type of encryption used on the bucket where export data will be stored.ExportTableToPointInTimeRequest.Builders3SseKmsKeyId(String s3SseKmsKeyId)The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).ExportTableToPointInTimeRequest.BuildertableArn(String tableArn)The Amazon Resource Name (ARN) associated with the table to export.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
tableArn
ExportTableToPointInTimeRequest.Builder tableArn(String tableArn)
The Amazon Resource Name (ARN) associated with the table to export.
- Parameters:
tableArn- The Amazon Resource Name (ARN) associated with the table to export.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exportTime
ExportTableToPointInTimeRequest.Builder exportTime(Instant exportTime)
Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.
- Parameters:
exportTime- Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
ExportTableToPointInTimeRequest.Builder clientToken(String clientToken)
Providing a
ClientTokenmakes the call toExportTableToPointInTimeInputidempotent, meaning that multiple identical calls have the same effect as one single call.A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an
ImportConflictException.- Parameters:
clientToken- Providing aClientTokenmakes the call toExportTableToPointInTimeInputidempotent, meaning that multiple identical calls have the same effect as one single call.A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an
ImportConflictException.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Bucket
ExportTableToPointInTimeRequest.Builder s3Bucket(String s3Bucket)
The name of the Amazon S3 bucket to export the snapshot to.
- Parameters:
s3Bucket- The name of the Amazon S3 bucket to export the snapshot to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3BucketOwner
ExportTableToPointInTimeRequest.Builder s3BucketOwner(String s3BucketOwner)
The ID of the Amazon Web Services account that owns the bucket the export will be stored in.
S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.
- Parameters:
s3BucketOwner- The ID of the Amazon Web Services account that owns the bucket the export will be stored in.S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Prefix
ExportTableToPointInTimeRequest.Builder s3Prefix(String s3Prefix)
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
- Parameters:
s3Prefix- The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3SseAlgorithm
ExportTableToPointInTimeRequest.Builder s3SseAlgorithm(String s3SseAlgorithm)
Type of encryption used on the bucket where export data will be stored. Valid values for
S3SseAlgorithmare:-
AES256- server-side encryption with Amazon S3 managed keys -
KMS- server-side encryption with KMS managed keys
- Parameters:
s3SseAlgorithm- Type of encryption used on the bucket where export data will be stored. Valid values forS3SseAlgorithmare:-
AES256- server-side encryption with Amazon S3 managed keys -
KMS- server-side encryption with KMS managed keys
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
S3SseAlgorithm,S3SseAlgorithm
-
-
s3SseAlgorithm
ExportTableToPointInTimeRequest.Builder s3SseAlgorithm(S3SseAlgorithm s3SseAlgorithm)
Type of encryption used on the bucket where export data will be stored. Valid values for
S3SseAlgorithmare:-
AES256- server-side encryption with Amazon S3 managed keys -
KMS- server-side encryption with KMS managed keys
- Parameters:
s3SseAlgorithm- Type of encryption used on the bucket where export data will be stored. Valid values forS3SseAlgorithmare:-
AES256- server-side encryption with Amazon S3 managed keys -
KMS- server-side encryption with KMS managed keys
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
S3SseAlgorithm,S3SseAlgorithm
-
-
s3SseKmsKeyId
ExportTableToPointInTimeRequest.Builder s3SseKmsKeyId(String s3SseKmsKeyId)
The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).
- Parameters:
s3SseKmsKeyId- The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exportFormat
ExportTableToPointInTimeRequest.Builder exportFormat(String exportFormat)
The format for the exported data. Valid values for
ExportFormatareDYNAMODB_JSONorION.- Parameters:
exportFormat- The format for the exported data. Valid values forExportFormatareDYNAMODB_JSONorION.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExportFormat,ExportFormat
-
exportFormat
ExportTableToPointInTimeRequest.Builder exportFormat(ExportFormat exportFormat)
The format for the exported data. Valid values for
ExportFormatareDYNAMODB_JSONorION.- Parameters:
exportFormat- The format for the exported data. Valid values forExportFormatareDYNAMODB_JSONorION.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExportFormat,ExportFormat
-
exportType
ExportTableToPointInTimeRequest.Builder exportType(String exportType)
Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
- Parameters:
exportType- Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExportType,ExportType
-
exportType
ExportTableToPointInTimeRequest.Builder exportType(ExportType exportType)
Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
- Parameters:
exportType- Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ExportType,ExportType
-
incrementalExportSpecification
ExportTableToPointInTimeRequest.Builder incrementalExportSpecification(IncrementalExportSpecification incrementalExportSpecification)
Optional object containing the parameters specific to an incremental export.
- Parameters:
incrementalExportSpecification- Optional object containing the parameters specific to an incremental export.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
incrementalExportSpecification
default ExportTableToPointInTimeRequest.Builder incrementalExportSpecification(Consumer<IncrementalExportSpecification.Builder> incrementalExportSpecification)
Optional object containing the parameters specific to an incremental export.
This is a convenience method that creates an instance of theIncrementalExportSpecification.Builderavoiding the need to create one manually viaIncrementalExportSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toincrementalExportSpecification(IncrementalExportSpecification).- Parameters:
incrementalExportSpecification- a consumer that will call methods onIncrementalExportSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
incrementalExportSpecification(IncrementalExportSpecification)
-
overrideConfiguration
ExportTableToPointInTimeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ExportTableToPointInTimeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-