software.amazon.awssdk.services.storagegateway.model

Interface CreateSmbFileShareRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>, SdkBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder

Enclosing class:

CreateSmbFileShareRequest

public static interface CreateSmbFileShareRequest.Builder
extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>

Method Summary

Modifier and Type	Method and Description
CreateSmbFileShareRequest.Builder	authentication(String authentication) The authentication method that users use to access the file share.
CreateSmbFileShareRequest.Builder	clientToken(String clientToken) A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
CreateSmbFileShareRequest.Builder	defaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by the file gateway.
CreateSmbFileShareRequest.Builder	gatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
CreateSmbFileShareRequest.Builder	guessMIMETypeEnabled(Boolean guessMIMETypeEnabled) A value that enables guessing of the MIME type for uploaded objects based on file extensions.
CreateSmbFileShareRequest.Builder	invalidUserList(Collection<String> invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
CreateSmbFileShareRequest.Builder	invalidUserList(String... invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
CreateSmbFileShareRequest.Builder	kmsEncrypted(Boolean kmsEncrypted) True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
CreateSmbFileShareRequest.Builder	kmsKey(String kmsKey) The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
CreateSmbFileShareRequest.Builder	locationARN(String locationARN) The ARN of the backed storage used for storing file data.
CreateSmbFileShareRequest.Builder	objectACL(ObjectACL objectACL) A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
CreateSmbFileShareRequest.Builder	objectACL(String objectACL) A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
CreateSmbFileShareRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateSmbFileShareRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateSmbFileShareRequest.Builder	readOnly(Boolean readOnly) A value that sets the write status of a file share.
CreateSmbFileShareRequest.Builder	requesterPays(Boolean requesterPays) A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into.
CreateSmbFileShareRequest.Builder	role(String role) The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
CreateSmbFileShareRequest.Builder	validUserList(Collection<String> validUserList) A list of users or groups in the Active Directory that are allowed to access the file share.
CreateSmbFileShareRequest.Builder	validUserList(String... validUserList) A list of users or groups in the Active Directory that are allowed to access the file share.

Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientToken

CreateSmbFileShareRequest.Builder clientToken(String clientToken)

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Parameters:

clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Returns:

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

gatewayARN

CreateSmbFileShareRequest.Builder gatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Returns:

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

kmsEncrypted

CreateSmbFileShareRequest.Builder kmsEncrypted(Boolean kmsEncrypted)

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Parameters:

kmsEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

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

kmsKey

CreateSmbFileShareRequest.Builder kmsKey(String kmsKey)

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Parameters:

kmsKey - The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

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

role

CreateSmbFileShareRequest.Builder role(String role)

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Parameters:

role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Returns:

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

locationARN

CreateSmbFileShareRequest.Builder locationARN(String locationARN)

The ARN of the backed storage used for storing file data.

Parameters:

locationARN - The ARN of the backed storage used for storing file data.

Returns:

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

defaultStorageClass

CreateSmbFileShareRequest.Builder defaultStorageClass(String defaultStorageClass)

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Parameters:

defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Returns:

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

objectACL

CreateSmbFileShareRequest.Builder objectACL(String objectACL)

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Parameters:

objectACL - A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Returns:

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

See Also:

ObjectACL, ObjectACL

objectACL

CreateSmbFileShareRequest.Builder objectACL(ObjectACL objectACL)

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Parameters:

objectACL - A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Returns:

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

See Also:

ObjectACL, ObjectACL

readOnly

CreateSmbFileShareRequest.Builder readOnly(Boolean readOnly)

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Parameters:

readOnly - A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Returns:

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

guessMIMETypeEnabled

CreateSmbFileShareRequest.Builder guessMIMETypeEnabled(Boolean guessMIMETypeEnabled)

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

Parameters:

guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

Returns:

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

requesterPays

CreateSmbFileShareRequest.Builder requesterPays(Boolean requesterPays)

A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.

Parameters:

requesterPays - A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.

Returns:

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

validUserList

CreateSmbFileShareRequest.Builder validUserList(Collection<String> validUserList)

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

validUserList - A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

validUserList

CreateSmbFileShareRequest.Builder validUserList(String... validUserList)

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

validUserList - A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

invalidUserList

CreateSmbFileShareRequest.Builder invalidUserList(Collection<String> invalidUserList)

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

invalidUserList - A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

invalidUserList

CreateSmbFileShareRequest.Builder invalidUserList(String... invalidUserList)

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

invalidUserList - A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

authentication

CreateSmbFileShareRequest.Builder authentication(String authentication)

The authentication method that users use to access the file share.

Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

Parameters:

authentication - The authentication method that users use to access the file share.

Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

Returns:

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

overrideConfiguration

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

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