Package software.amazon.awssdk.services.datasync.model

Interface CreateLocationS3Request.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>, DataSyncRequest.Builder, SdkBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateLocationS3Request
public static interface CreateLocationS3Request.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateLocationS3Request.Builder,CreateLocationS3Request>

  • Method Details

    • subdirectory

      CreateLocationS3Request.Builder subdirectory(String subdirectory)

      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

      Parameters:
      subdirectory - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3BucketArn

      CreateLocationS3Request.Builder s3BucketArn(String s3BucketArn)

      Specifies the ARN of the S3 bucket that you want to use as a location. (When creating your DataSync task later, you specify whether this location is a transfer source or destination.)

      If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access point. For more information, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

      Parameters:
      s3BucketArn - Specifies the ARN of the S3 bucket that you want to use as a location. (When creating your DataSync task later, you specify whether this location is a transfer source or destination.)

      If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access point. For more information, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3StorageClass

      CreateLocationS3Request.Builder s3StorageClass(String s3StorageClass)

      Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

      For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

      For more information, see Storage class considerations with Amazon S3 transfers.

      Parameters:
      s3StorageClass - Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

      For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

      For more information, see Storage class considerations with Amazon S3 transfers.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • s3StorageClass

      CreateLocationS3Request.Builder s3StorageClass(S3StorageClass s3StorageClass)

      Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

      For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

      For more information, see Storage class considerations with Amazon S3 transfers.

      Parameters:
      s3StorageClass - Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

      For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

      For more information, see Storage class considerations with Amazon S3 transfers.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • s3Config

      CreateLocationS3Request.Builder s3Config(S3Config s3Config)
      Sets the value of the S3Config property for this object.
      Parameters:
      s3Config - The new value for the S3Config property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3Config

      default CreateLocationS3Request.Builder s3Config(Consumer<S3Config.Builder> s3Config)
      Sets the value of the S3Config property for this object. This is a convenience method that creates an instance of the S3Config.Builder avoiding the need to create one manually via S3Config.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Config(S3Config).

      Parameters:
      s3Config - a consumer that will call methods on S3Config.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • agentArns

      CreateLocationS3Request.Builder agentArns(Collection<String> agentArns)

      (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.

      For more information, see Deploy your DataSync agent on Outposts.

      Parameters:
      agentArns - (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.

      For more information, see Deploy your DataSync agent on Outposts.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentArns

      CreateLocationS3Request.Builder agentArns(String... agentArns)

      (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.

      For more information, see Deploy your DataSync agent on Outposts.

      Parameters:
      agentArns - (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.

      For more information, see Deploy your DataSync agent on Outposts.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationS3Request.Builder tags(Collection<TagListEntry> tags)

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

      Parameters:
      tags - Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationS3Request.Builder tags(TagListEntry... tags)

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

      Parameters:
      tags - Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationS3Request.Builder tags(Consumer<TagListEntry.Builder>... tags)

      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

      This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

      Parameters:
      tags - a consumer that will call methods on TagListEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateLocationS3Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateLocationS3Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.