com.pulumi.aws.storagegateway.inputs.SmbFileShareState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.storagegateway.inputs;
import com.pulumi.aws.storagegateway.inputs.SmbFileShareCacheAttributesArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class SmbFileShareState extends com.pulumi.resources.ResourceArgs {
public static final SmbFileShareState Empty = new SmbFileShareState();
/**
* The files and folders on this share will only be visible to users with read access. Default value is `false`.
*
*/
@Import(name="accessBasedEnumeration")
private @Nullable Output accessBasedEnumeration;
/**
* @return The files and folders on this share will only be visible to users with read access. Default value is `false`.
*
*/
public Optional> accessBasedEnumeration() {
return Optional.ofNullable(this.accessBasedEnumeration);
}
/**
* A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
*/
@Import(name="adminUserLists")
private @Nullable Output> adminUserLists;
/**
* @return A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
*/
public Optional>> adminUserLists() {
return Optional.ofNullable(this.adminUserLists);
}
/**
* Amazon Resource Name (ARN) of the SMB File Share.
*
*/
@Import(name="arn")
private @Nullable Output arn;
/**
* @return Amazon Resource Name (ARN) of the SMB File Share.
*
*/
public Optional> arn() {
return Optional.ofNullable(this.arn);
}
/**
* The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
*
*/
@Import(name="auditDestinationArn")
private @Nullable Output auditDestinationArn;
/**
* @return The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
*
*/
public Optional> auditDestinationArn() {
return Optional.ofNullable(this.auditDestinationArn);
}
/**
* The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
*
*/
@Import(name="authentication")
private @Nullable Output authentication;
/**
* @return The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
*
*/
public Optional> authentication() {
return Optional.ofNullable(this.authentication);
}
/**
* The region of the S3 buck used by the file share. Required when specifying a `vpc_endpoint_dns_name`.
*
*/
@Import(name="bucketRegion")
private @Nullable Output bucketRegion;
/**
* @return The region of the S3 buck used by the file share. Required when specifying a `vpc_endpoint_dns_name`.
*
*/
public Optional> bucketRegion() {
return Optional.ofNullable(this.bucketRegion);
}
/**
* Refresh cache information. see `cache_attributes` Block for more details.
*
* **Note:** If you have previously included a `cache_attributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.
*
*/
@Import(name="cacheAttributes")
private @Nullable Output cacheAttributes;
/**
* @return Refresh cache information. see `cache_attributes` Block for more details.
*
* **Note:** If you have previously included a `cache_attributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.
*
*/
public Optional> cacheAttributes() {
return Optional.ofNullable(this.cacheAttributes);
}
/**
* The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.
*
*/
@Import(name="caseSensitivity")
private @Nullable Output caseSensitivity;
/**
* @return The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.
*
*/
public Optional> caseSensitivity() {
return Optional.ofNullable(this.caseSensitivity);
}
/**
* The default [storage class](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-DefaultStorageClass) for objects put into an Amazon S3 bucket by the file gateway. Defaults to `S3_STANDARD`.
*
*/
@Import(name="defaultStorageClass")
private @Nullable Output defaultStorageClass;
/**
* @return The default [storage class](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-DefaultStorageClass) for objects put into an Amazon S3 bucket by the file gateway. Defaults to `S3_STANDARD`.
*
*/
public Optional> defaultStorageClass() {
return Optional.ofNullable(this.defaultStorageClass);
}
/**
* The name of the file share. Must be set if an S3 prefix name is set in `location_arn`.
*
*/
@Import(name="fileShareName")
private @Nullable Output fileShareName;
/**
* @return The name of the file share. Must be set if an S3 prefix name is set in `location_arn`.
*
*/
public Optional> fileShareName() {
return Optional.ofNullable(this.fileShareName);
}
/**
* ID of the SMB File Share.
*
*/
@Import(name="fileshareId")
private @Nullable Output fileshareId;
/**
* @return ID of the SMB File Share.
*
*/
public Optional> fileshareId() {
return Optional.ofNullable(this.fileshareId);
}
/**
* Amazon Resource Name (ARN) of the file gateway.
*
*/
@Import(name="gatewayArn")
private @Nullable Output gatewayArn;
/**
* @return Amazon Resource Name (ARN) of the file gateway.
*
*/
public Optional> gatewayArn() {
return Optional.ofNullable(this.gatewayArn);
}
/**
* Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
*
*/
@Import(name="guessMimeTypeEnabled")
private @Nullable Output guessMimeTypeEnabled;
/**
* @return Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
*
*/
public Optional> guessMimeTypeEnabled() {
return Optional.ofNullable(this.guessMimeTypeEnabled);
}
/**
* A list of users in the Active Directory that are not allowed to access the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
*/
@Import(name="invalidUserLists")
private @Nullable Output> invalidUserLists;
/**
* @return A list of users in the Active Directory that are not allowed to access the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
*/
public Optional>> invalidUserLists() {
return Optional.ofNullable(this.invalidUserLists);
}
/**
* Boolean value if `true` to use Amazon S3 server side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Defaults to `false`.
*
*/
@Import(name="kmsEncrypted")
private @Nullable Output kmsEncrypted;
/**
* @return Boolean value if `true` to use Amazon S3 server side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Defaults to `false`.
*
*/
public Optional> kmsEncrypted() {
return Optional.ofNullable(this.kmsEncrypted);
}
/**
* Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
*
*/
@Import(name="kmsKeyArn")
private @Nullable Output kmsKeyArn;
/**
* @return Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
*
*/
public Optional> kmsKeyArn() {
return Optional.ofNullable(this.kmsKeyArn);
}
/**
* The ARN of the backed storage used for storing file data.
*
*/
@Import(name="locationArn")
private @Nullable Output locationArn;
/**
* @return The ARN of the backed storage used for storing file data.
*
*/
public Optional> locationArn() {
return Optional.ofNullable(this.locationArn);
}
/**
* The notification policy of the file share. For more information see the [AWS Documentation](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-NotificationPolicy). Default value is `{}`.
*
*/
@Import(name="notificationPolicy")
private @Nullable Output notificationPolicy;
/**
* @return The notification policy of the file share. For more information see the [AWS Documentation](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-NotificationPolicy). Default value is `{}`.
*
*/
public Optional> notificationPolicy() {
return Optional.ofNullable(this.notificationPolicy);
}
/**
* Access Control List permission for S3 objects. Defaults to `private`.
*
*/
@Import(name="objectAcl")
private @Nullable Output objectAcl;
/**
* @return Access Control List permission for S3 objects. Defaults to `private`.
*
*/
public Optional> objectAcl() {
return Optional.ofNullable(this.objectAcl);
}
/**
* Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`.
*
*/
@Import(name="oplocksEnabled")
private @Nullable Output oplocksEnabled;
/**
* @return Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`.
*
*/
public Optional> oplocksEnabled() {
return Optional.ofNullable(this.oplocksEnabled);
}
/**
* File share path used by the NFS client to identify the mount point.
*
*/
@Import(name="path")
private @Nullable Output path;
/**
* @return File share path used by the NFS client to identify the mount point.
*
*/
public Optional> path() {
return Optional.ofNullable(this.path);
}
/**
* Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
*
*/
@Import(name="readOnly")
private @Nullable Output readOnly;
/**
* @return Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
*
*/
public Optional> readOnly() {
return Optional.ofNullable(this.readOnly);
}
/**
* Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to `true` if you want the requester to pay instead of the bucket owner. Defaults to `false`.
*
*/
@Import(name="requesterPays")
private @Nullable Output requesterPays;
/**
* @return Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to `true` if you want the requester to pay instead of the bucket owner. Defaults to `false`.
*
*/
public Optional> requesterPays() {
return Optional.ofNullable(this.requesterPays);
}
/**
* The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
*
*/
@Import(name="roleArn")
private @Nullable Output roleArn;
/**
* @return The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
*
*/
public Optional> roleArn() {
return Optional.ofNullable(this.roleArn);
}
/**
* Set this value to `true` to enable ACL (access control list) on the SMB fileshare. Set it to `false` to map file and directory permissions to the POSIX permissions. This setting applies only to `ActiveDirectory` authentication type.
*
*/
@Import(name="smbAclEnabled")
private @Nullable Output smbAclEnabled;
/**
* @return Set this value to `true` to enable ACL (access control list) on the SMB fileshare. Set it to `false` to map file and directory permissions to the POSIX permissions. This setting applies only to `ActiveDirectory` authentication type.
*
*/
public Optional> smbAclEnabled() {
return Optional.ofNullable(this.smbAclEnabled);
}
/**
* Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Import(name="tagsAll")
private @Nullable Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Optional>> tagsAll() {
return Optional.ofNullable(this.tagsAll);
}
/**
* A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '{@literal @}' before the name of the group. It will be set on Allowed group in AWS console. Only valid if `authentication` is set to `ActiveDirectory`.
*
*/
@Import(name="validUserLists")
private @Nullable Output> validUserLists;
/**
* @return A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '{@literal @}' before the name of the group. It will be set on Allowed group in AWS console. Only valid if `authentication` is set to `ActiveDirectory`.
*
*/
public Optional>> validUserLists() {
return Optional.ofNullable(this.validUserLists);
}
/**
* The DNS name of the VPC endpoint for S3 private link.
*
*/
@Import(name="vpcEndpointDnsName")
private @Nullable Output vpcEndpointDnsName;
/**
* @return The DNS name of the VPC endpoint for S3 private link.
*
*/
public Optional> vpcEndpointDnsName() {
return Optional.ofNullable(this.vpcEndpointDnsName);
}
private SmbFileShareState() {}
private SmbFileShareState(SmbFileShareState $) {
this.accessBasedEnumeration = $.accessBasedEnumeration;
this.adminUserLists = $.adminUserLists;
this.arn = $.arn;
this.auditDestinationArn = $.auditDestinationArn;
this.authentication = $.authentication;
this.bucketRegion = $.bucketRegion;
this.cacheAttributes = $.cacheAttributes;
this.caseSensitivity = $.caseSensitivity;
this.defaultStorageClass = $.defaultStorageClass;
this.fileShareName = $.fileShareName;
this.fileshareId = $.fileshareId;
this.gatewayArn = $.gatewayArn;
this.guessMimeTypeEnabled = $.guessMimeTypeEnabled;
this.invalidUserLists = $.invalidUserLists;
this.kmsEncrypted = $.kmsEncrypted;
this.kmsKeyArn = $.kmsKeyArn;
this.locationArn = $.locationArn;
this.notificationPolicy = $.notificationPolicy;
this.objectAcl = $.objectAcl;
this.oplocksEnabled = $.oplocksEnabled;
this.path = $.path;
this.readOnly = $.readOnly;
this.requesterPays = $.requesterPays;
this.roleArn = $.roleArn;
this.smbAclEnabled = $.smbAclEnabled;
this.tags = $.tags;
this.tagsAll = $.tagsAll;
this.validUserLists = $.validUserLists;
this.vpcEndpointDnsName = $.vpcEndpointDnsName;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(SmbFileShareState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private SmbFileShareState $;
public Builder() {
$ = new SmbFileShareState();
}
public Builder(SmbFileShareState defaults) {
$ = new SmbFileShareState(Objects.requireNonNull(defaults));
}
/**
* @param accessBasedEnumeration The files and folders on this share will only be visible to users with read access. Default value is `false`.
*
* @return builder
*
*/
public Builder accessBasedEnumeration(@Nullable Output accessBasedEnumeration) {
$.accessBasedEnumeration = accessBasedEnumeration;
return this;
}
/**
* @param accessBasedEnumeration The files and folders on this share will only be visible to users with read access. Default value is `false`.
*
* @return builder
*
*/
public Builder accessBasedEnumeration(Boolean accessBasedEnumeration) {
return accessBasedEnumeration(Output.of(accessBasedEnumeration));
}
/**
* @param adminUserLists A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder adminUserLists(@Nullable Output> adminUserLists) {
$.adminUserLists = adminUserLists;
return this;
}
/**
* @param adminUserLists A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder adminUserLists(List adminUserLists) {
return adminUserLists(Output.of(adminUserLists));
}
/**
* @param adminUserLists A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder adminUserLists(String... adminUserLists) {
return adminUserLists(List.of(adminUserLists));
}
/**
* @param arn Amazon Resource Name (ARN) of the SMB File Share.
*
* @return builder
*
*/
public Builder arn(@Nullable Output arn) {
$.arn = arn;
return this;
}
/**
* @param arn Amazon Resource Name (ARN) of the SMB File Share.
*
* @return builder
*
*/
public Builder arn(String arn) {
return arn(Output.of(arn));
}
/**
* @param auditDestinationArn The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
*
* @return builder
*
*/
public Builder auditDestinationArn(@Nullable Output auditDestinationArn) {
$.auditDestinationArn = auditDestinationArn;
return this;
}
/**
* @param auditDestinationArn The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
*
* @return builder
*
*/
public Builder auditDestinationArn(String auditDestinationArn) {
return auditDestinationArn(Output.of(auditDestinationArn));
}
/**
* @param authentication The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
*
* @return builder
*
*/
public Builder authentication(@Nullable Output authentication) {
$.authentication = authentication;
return this;
}
/**
* @param authentication The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
*
* @return builder
*
*/
public Builder authentication(String authentication) {
return authentication(Output.of(authentication));
}
/**
* @param bucketRegion The region of the S3 buck used by the file share. Required when specifying a `vpc_endpoint_dns_name`.
*
* @return builder
*
*/
public Builder bucketRegion(@Nullable Output bucketRegion) {
$.bucketRegion = bucketRegion;
return this;
}
/**
* @param bucketRegion The region of the S3 buck used by the file share. Required when specifying a `vpc_endpoint_dns_name`.
*
* @return builder
*
*/
public Builder bucketRegion(String bucketRegion) {
return bucketRegion(Output.of(bucketRegion));
}
/**
* @param cacheAttributes Refresh cache information. see `cache_attributes` Block for more details.
*
* **Note:** If you have previously included a `cache_attributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.
*
* @return builder
*
*/
public Builder cacheAttributes(@Nullable Output cacheAttributes) {
$.cacheAttributes = cacheAttributes;
return this;
}
/**
* @param cacheAttributes Refresh cache information. see `cache_attributes` Block for more details.
*
* **Note:** If you have previously included a `cache_attributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.
*
* @return builder
*
*/
public Builder cacheAttributes(SmbFileShareCacheAttributesArgs cacheAttributes) {
return cacheAttributes(Output.of(cacheAttributes));
}
/**
* @param caseSensitivity The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.
*
* @return builder
*
*/
public Builder caseSensitivity(@Nullable Output caseSensitivity) {
$.caseSensitivity = caseSensitivity;
return this;
}
/**
* @param caseSensitivity The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.
*
* @return builder
*
*/
public Builder caseSensitivity(String caseSensitivity) {
return caseSensitivity(Output.of(caseSensitivity));
}
/**
* @param defaultStorageClass The default [storage class](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-DefaultStorageClass) for objects put into an Amazon S3 bucket by the file gateway. Defaults to `S3_STANDARD`.
*
* @return builder
*
*/
public Builder defaultStorageClass(@Nullable Output defaultStorageClass) {
$.defaultStorageClass = defaultStorageClass;
return this;
}
/**
* @param defaultStorageClass The default [storage class](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-DefaultStorageClass) for objects put into an Amazon S3 bucket by the file gateway. Defaults to `S3_STANDARD`.
*
* @return builder
*
*/
public Builder defaultStorageClass(String defaultStorageClass) {
return defaultStorageClass(Output.of(defaultStorageClass));
}
/**
* @param fileShareName The name of the file share. Must be set if an S3 prefix name is set in `location_arn`.
*
* @return builder
*
*/
public Builder fileShareName(@Nullable Output fileShareName) {
$.fileShareName = fileShareName;
return this;
}
/**
* @param fileShareName The name of the file share. Must be set if an S3 prefix name is set in `location_arn`.
*
* @return builder
*
*/
public Builder fileShareName(String fileShareName) {
return fileShareName(Output.of(fileShareName));
}
/**
* @param fileshareId ID of the SMB File Share.
*
* @return builder
*
*/
public Builder fileshareId(@Nullable Output fileshareId) {
$.fileshareId = fileshareId;
return this;
}
/**
* @param fileshareId ID of the SMB File Share.
*
* @return builder
*
*/
public Builder fileshareId(String fileshareId) {
return fileshareId(Output.of(fileshareId));
}
/**
* @param gatewayArn Amazon Resource Name (ARN) of the file gateway.
*
* @return builder
*
*/
public Builder gatewayArn(@Nullable Output gatewayArn) {
$.gatewayArn = gatewayArn;
return this;
}
/**
* @param gatewayArn Amazon Resource Name (ARN) of the file gateway.
*
* @return builder
*
*/
public Builder gatewayArn(String gatewayArn) {
return gatewayArn(Output.of(gatewayArn));
}
/**
* @param guessMimeTypeEnabled Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
*
* @return builder
*
*/
public Builder guessMimeTypeEnabled(@Nullable Output guessMimeTypeEnabled) {
$.guessMimeTypeEnabled = guessMimeTypeEnabled;
return this;
}
/**
* @param guessMimeTypeEnabled Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
*
* @return builder
*
*/
public Builder guessMimeTypeEnabled(Boolean guessMimeTypeEnabled) {
return guessMimeTypeEnabled(Output.of(guessMimeTypeEnabled));
}
/**
* @param invalidUserLists A list of users in the Active Directory that are not allowed to access the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder invalidUserLists(@Nullable Output> invalidUserLists) {
$.invalidUserLists = invalidUserLists;
return this;
}
/**
* @param invalidUserLists A list of users in the Active Directory that are not allowed to access the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder invalidUserLists(List invalidUserLists) {
return invalidUserLists(Output.of(invalidUserLists));
}
/**
* @param invalidUserLists A list of users in the Active Directory that are not allowed to access the file share. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder invalidUserLists(String... invalidUserLists) {
return invalidUserLists(List.of(invalidUserLists));
}
/**
* @param kmsEncrypted Boolean value if `true` to use Amazon S3 server side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Defaults to `false`.
*
* @return builder
*
*/
public Builder kmsEncrypted(@Nullable Output kmsEncrypted) {
$.kmsEncrypted = kmsEncrypted;
return this;
}
/**
* @param kmsEncrypted Boolean value if `true` to use Amazon S3 server side encryption with your own AWS KMS key, or `false` to use a key managed by Amazon S3. Defaults to `false`.
*
* @return builder
*
*/
public Builder kmsEncrypted(Boolean kmsEncrypted) {
return kmsEncrypted(Output.of(kmsEncrypted));
}
/**
* @param kmsKeyArn Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
*
* @return builder
*
*/
public Builder kmsKeyArn(@Nullable Output kmsKeyArn) {
$.kmsKeyArn = kmsKeyArn;
return this;
}
/**
* @param kmsKeyArn Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
*
* @return builder
*
*/
public Builder kmsKeyArn(String kmsKeyArn) {
return kmsKeyArn(Output.of(kmsKeyArn));
}
/**
* @param locationArn The ARN of the backed storage used for storing file data.
*
* @return builder
*
*/
public Builder locationArn(@Nullable Output locationArn) {
$.locationArn = locationArn;
return this;
}
/**
* @param locationArn The ARN of the backed storage used for storing file data.
*
* @return builder
*
*/
public Builder locationArn(String locationArn) {
return locationArn(Output.of(locationArn));
}
/**
* @param notificationPolicy The notification policy of the file share. For more information see the [AWS Documentation](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-NotificationPolicy). Default value is `{}`.
*
* @return builder
*
*/
public Builder notificationPolicy(@Nullable Output notificationPolicy) {
$.notificationPolicy = notificationPolicy;
return this;
}
/**
* @param notificationPolicy The notification policy of the file share. For more information see the [AWS Documentation](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-NotificationPolicy). Default value is `{}`.
*
* @return builder
*
*/
public Builder notificationPolicy(String notificationPolicy) {
return notificationPolicy(Output.of(notificationPolicy));
}
/**
* @param objectAcl Access Control List permission for S3 objects. Defaults to `private`.
*
* @return builder
*
*/
public Builder objectAcl(@Nullable Output objectAcl) {
$.objectAcl = objectAcl;
return this;
}
/**
* @param objectAcl Access Control List permission for S3 objects. Defaults to `private`.
*
* @return builder
*
*/
public Builder objectAcl(String objectAcl) {
return objectAcl(Output.of(objectAcl));
}
/**
* @param oplocksEnabled Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`.
*
* @return builder
*
*/
public Builder oplocksEnabled(@Nullable Output oplocksEnabled) {
$.oplocksEnabled = oplocksEnabled;
return this;
}
/**
* @param oplocksEnabled Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`.
*
* @return builder
*
*/
public Builder oplocksEnabled(Boolean oplocksEnabled) {
return oplocksEnabled(Output.of(oplocksEnabled));
}
/**
* @param path File share path used by the NFS client to identify the mount point.
*
* @return builder
*
*/
public Builder path(@Nullable Output path) {
$.path = path;
return this;
}
/**
* @param path File share path used by the NFS client to identify the mount point.
*
* @return builder
*
*/
public Builder path(String path) {
return path(Output.of(path));
}
/**
* @param readOnly Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
*
* @return builder
*
*/
public Builder readOnly(@Nullable Output readOnly) {
$.readOnly = readOnly;
return this;
}
/**
* @param readOnly Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
*
* @return builder
*
*/
public Builder readOnly(Boolean readOnly) {
return readOnly(Output.of(readOnly));
}
/**
* @param requesterPays Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to `true` if you want the requester to pay instead of the bucket owner. Defaults to `false`.
*
* @return builder
*
*/
public Builder requesterPays(@Nullable Output requesterPays) {
$.requesterPays = requesterPays;
return this;
}
/**
* @param requesterPays Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to `true` if you want the requester to pay instead of the bucket owner. Defaults to `false`.
*
* @return builder
*
*/
public Builder requesterPays(Boolean requesterPays) {
return requesterPays(Output.of(requesterPays));
}
/**
* @param roleArn The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
*
* @return builder
*
*/
public Builder roleArn(@Nullable Output roleArn) {
$.roleArn = roleArn;
return this;
}
/**
* @param roleArn The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
*
* @return builder
*
*/
public Builder roleArn(String roleArn) {
return roleArn(Output.of(roleArn));
}
/**
* @param smbAclEnabled Set this value to `true` to enable ACL (access control list) on the SMB fileshare. Set it to `false` to map file and directory permissions to the POSIX permissions. This setting applies only to `ActiveDirectory` authentication type.
*
* @return builder
*
*/
public Builder smbAclEnabled(@Nullable Output smbAclEnabled) {
$.smbAclEnabled = smbAclEnabled;
return this;
}
/**
* @param smbAclEnabled Set this value to `true` to enable ACL (access control list) on the SMB fileshare. Set it to `false` to map file and directory permissions to the POSIX permissions. This setting applies only to `ActiveDirectory` authentication type.
*
* @return builder
*
*/
public Builder smbAclEnabled(Boolean smbAclEnabled) {
return smbAclEnabled(Output.of(smbAclEnabled));
}
/**
* @param tags Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param tagsAll A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(@Nullable Output> tagsAll) {
$.tagsAll = tagsAll;
return this;
}
/**
* @param tagsAll A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(Map tagsAll) {
return tagsAll(Output.of(tagsAll));
}
/**
* @param validUserLists A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '{@literal @}' before the name of the group. It will be set on Allowed group in AWS console. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder validUserLists(@Nullable Output> validUserLists) {
$.validUserLists = validUserLists;
return this;
}
/**
* @param validUserLists A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '{@literal @}' before the name of the group. It will be set on Allowed group in AWS console. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder validUserLists(List validUserLists) {
return validUserLists(Output.of(validUserLists));
}
/**
* @param validUserLists A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '{@literal @}' before the name of the group. It will be set on Allowed group in AWS console. Only valid if `authentication` is set to `ActiveDirectory`.
*
* @return builder
*
*/
public Builder validUserLists(String... validUserLists) {
return validUserLists(List.of(validUserLists));
}
/**
* @param vpcEndpointDnsName The DNS name of the VPC endpoint for S3 private link.
*
* @return builder
*
*/
public Builder vpcEndpointDnsName(@Nullable Output vpcEndpointDnsName) {
$.vpcEndpointDnsName = vpcEndpointDnsName;
return this;
}
/**
* @param vpcEndpointDnsName The DNS name of the VPC endpoint for S3 private link.
*
* @return builder
*
*/
public Builder vpcEndpointDnsName(String vpcEndpointDnsName) {
return vpcEndpointDnsName(Output.of(vpcEndpointDnsName));
}
public SmbFileShareState build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy