Interface CreateFileSystemRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>, S3FilesRequest.Builder, SdkBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFileSystemRequest
@Mutable @NotThreadSafe public static interface CreateFileSystemRequest.Builder extends S3FilesRequest.Builder, SdkPojo, CopyableBuilder<CreateFileSystemRequest.Builder,CreateFileSystemRequest>

  • Method Details

    • bucket

      CreateFileSystemRequest.Builder bucket(String bucket)

      The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system.

      Parameters:
      bucket - The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • prefix

      CreateFileSystemRequest.Builder prefix(String prefix)

      An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket.

      Parameters:
      prefix - An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateFileSystemRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure idempotent creation. Up to 64 ASCII characters are allowed. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateFileSystemRequest.Builder kmsKeyId(String kmsKeyId)

      The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use KmsKeyId, the file system will be encrypted.

      Parameters:
      kmsKeyId - The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use KmsKeyId, the file system will be encrypted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateFileSystemRequest.Builder roleArn(String roleArn)

      The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix.

      Parameters:
      roleArn - The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFileSystemRequest.Builder tags(Collection<Tag> tags)

      An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.

      Parameters:
      tags - An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFileSystemRequest.Builder tags(Tag... tags)

      An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.

      Parameters:
      tags - An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateFileSystemRequest.Builder tags(Consumer<Tag.Builder>... tags)

      An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource.

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

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

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

    • acceptBucketWarning

      CreateFileSystemRequest.Builder acceptBucketWarning(Boolean acceptBucketWarning)

      Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings.

      Parameters:
      acceptBucketWarning - Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateFileSystemRequest.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

      CreateFileSystemRequest.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.