com.pulumi.aws.storagegateway.NfsFileShareArgs 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;
import com.pulumi.aws.storagegateway.inputs.NfsFileShareCacheAttributesArgs;
import com.pulumi.aws.storagegateway.inputs.NfsFileShareNfsFileShareDefaultsArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
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 NfsFileShareArgs extends com.pulumi.resources.ResourceArgs {
public static final NfsFileShareArgs Empty = new NfsFileShareArgs();
/**
* The Amazon Resource Name (ARN) of the storage used for audit logs.
*
*/
@Import(name="auditDestinationArn")
private @Nullable Output auditDestinationArn;
/**
* @return The Amazon Resource Name (ARN) of the storage used for audit logs.
*
*/
public Optional> auditDestinationArn() {
return Optional.ofNullable(this.auditDestinationArn);
}
/**
* The region of the S3 bucket used by the file share. Required when specifying `vpc_endpoint_dns_name`.
*
*/
@Import(name="bucketRegion")
private @Nullable Output bucketRegion;
/**
* @return The region of the S3 bucket used by the file share. Required when specifying `vpc_endpoint_dns_name`.
*
*/
public Optional> bucketRegion() {
return Optional.ofNullable(this.bucketRegion);
}
/**
* Refresh cache information. see Cache Attributes for more details.
*
*/
@Import(name="cacheAttributes")
private @Nullable Output cacheAttributes;
/**
* @return Refresh cache information. see Cache Attributes for more details.
*
*/
public Optional> cacheAttributes() {
return Optional.ofNullable(this.cacheAttributes);
}
/**
* The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to `["0.0.0.0/0"]` to not limit access. Minimum 1 item. Maximum 100 items.
*
*/
@Import(name="clientLists", required=true)
private Output> clientLists;
/**
* @return The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to `["0.0.0.0/0"]` to not limit access. Minimum 1 item. Maximum 100 items.
*
*/
public Output> clientLists() {
return this.clientLists;
}
/**
* 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);
}
/**
* Amazon Resource Name (ARN) of the file gateway.
*
*/
@Import(name="gatewayArn", required=true)
private Output gatewayArn;
/**
* @return Amazon Resource Name (ARN) of the file gateway.
*
*/
public Output gatewayArn() {
return 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);
}
/**
* 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", required=true)
private Output locationArn;
/**
* @return The ARN of the backed storage used for storing file data.
*
*/
public Output locationArn() {
return this.locationArn;
}
/**
* Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.
*
*/
@Import(name="nfsFileShareDefaults")
private @Nullable Output nfsFileShareDefaults;
/**
* @return Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.
*
*/
public Optional> nfsFileShareDefaults() {
return Optional.ofNullable(this.nfsFileShareDefaults);
}
/**
* 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 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", required=true)
private 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 Output roleArn() {
return this.roleArn;
}
/**
* Maps a user to anonymous user. Defaults to `RootSquash`. Valid values: `RootSquash` (only root is mapped to anonymous user), `NoSquash` (no one is mapped to anonymous user), `AllSquash` (everyone is mapped to anonymous user)
*
*/
@Import(name="squash")
private @Nullable Output squash;
/**
* @return Maps a user to anonymous user. Defaults to `RootSquash`. Valid values: `RootSquash` (only root is mapped to anonymous user), `NoSquash` (no one is mapped to anonymous user), `AllSquash` (everyone is mapped to anonymous user)
*
*/
public Optional> squash() {
return Optional.ofNullable(this.squash);
}
/**
* 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);
}
/**
* The DNS name of the VPC endpoint for S3 PrivateLink.
*
*/
@Import(name="vpcEndpointDnsName")
private @Nullable Output vpcEndpointDnsName;
/**
* @return The DNS name of the VPC endpoint for S3 PrivateLink.
*
*/
public Optional> vpcEndpointDnsName() {
return Optional.ofNullable(this.vpcEndpointDnsName);
}
private NfsFileShareArgs() {}
private NfsFileShareArgs(NfsFileShareArgs $) {
this.auditDestinationArn = $.auditDestinationArn;
this.bucketRegion = $.bucketRegion;
this.cacheAttributes = $.cacheAttributes;
this.clientLists = $.clientLists;
this.defaultStorageClass = $.defaultStorageClass;
this.fileShareName = $.fileShareName;
this.gatewayArn = $.gatewayArn;
this.guessMimeTypeEnabled = $.guessMimeTypeEnabled;
this.kmsEncrypted = $.kmsEncrypted;
this.kmsKeyArn = $.kmsKeyArn;
this.locationArn = $.locationArn;
this.nfsFileShareDefaults = $.nfsFileShareDefaults;
this.notificationPolicy = $.notificationPolicy;
this.objectAcl = $.objectAcl;
this.readOnly = $.readOnly;
this.requesterPays = $.requesterPays;
this.roleArn = $.roleArn;
this.squash = $.squash;
this.tags = $.tags;
this.vpcEndpointDnsName = $.vpcEndpointDnsName;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(NfsFileShareArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private NfsFileShareArgs $;
public Builder() {
$ = new NfsFileShareArgs();
}
public Builder(NfsFileShareArgs defaults) {
$ = new NfsFileShareArgs(Objects.requireNonNull(defaults));
}
/**
* @param auditDestinationArn The Amazon Resource Name (ARN) of the storage used for audit logs.
*
* @return builder
*
*/
public Builder auditDestinationArn(@Nullable Output auditDestinationArn) {
$.auditDestinationArn = auditDestinationArn;
return this;
}
/**
* @param auditDestinationArn The Amazon Resource Name (ARN) of the storage used for audit logs.
*
* @return builder
*
*/
public Builder auditDestinationArn(String auditDestinationArn) {
return auditDestinationArn(Output.of(auditDestinationArn));
}
/**
* @param bucketRegion The region of the S3 bucket used by the file share. Required when specifying `vpc_endpoint_dns_name`.
*
* @return builder
*
*/
public Builder bucketRegion(@Nullable Output bucketRegion) {
$.bucketRegion = bucketRegion;
return this;
}
/**
* @param bucketRegion The region of the S3 bucket used by the file share. Required when specifying `vpc_endpoint_dns_name`.
*
* @return builder
*
*/
public Builder bucketRegion(String bucketRegion) {
return bucketRegion(Output.of(bucketRegion));
}
/**
* @param cacheAttributes Refresh cache information. see Cache Attributes for more details.
*
* @return builder
*
*/
public Builder cacheAttributes(@Nullable Output cacheAttributes) {
$.cacheAttributes = cacheAttributes;
return this;
}
/**
* @param cacheAttributes Refresh cache information. see Cache Attributes for more details.
*
* @return builder
*
*/
public Builder cacheAttributes(NfsFileShareCacheAttributesArgs cacheAttributes) {
return cacheAttributes(Output.of(cacheAttributes));
}
/**
* @param clientLists The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to `["0.0.0.0/0"]` to not limit access. Minimum 1 item. Maximum 100 items.
*
* @return builder
*
*/
public Builder clientLists(Output> clientLists) {
$.clientLists = clientLists;
return this;
}
/**
* @param clientLists The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to `["0.0.0.0/0"]` to not limit access. Minimum 1 item. Maximum 100 items.
*
* @return builder
*
*/
public Builder clientLists(List clientLists) {
return clientLists(Output.of(clientLists));
}
/**
* @param clientLists The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to `["0.0.0.0/0"]` to not limit access. Minimum 1 item. Maximum 100 items.
*
* @return builder
*
*/
public Builder clientLists(String... clientLists) {
return clientLists(List.of(clientLists));
}
/**
* @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 gatewayArn Amazon Resource Name (ARN) of the file gateway.
*
* @return builder
*
*/
public Builder gatewayArn(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 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(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 nfsFileShareDefaults Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.
*
* @return builder
*
*/
public Builder nfsFileShareDefaults(@Nullable Output nfsFileShareDefaults) {
$.nfsFileShareDefaults = nfsFileShareDefaults;
return this;
}
/**
* @param nfsFileShareDefaults Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.
*
* @return builder
*
*/
public Builder nfsFileShareDefaults(NfsFileShareNfsFileShareDefaultsArgs nfsFileShareDefaults) {
return nfsFileShareDefaults(Output.of(nfsFileShareDefaults));
}
/**
* @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 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(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 squash Maps a user to anonymous user. Defaults to `RootSquash`. Valid values: `RootSquash` (only root is mapped to anonymous user), `NoSquash` (no one is mapped to anonymous user), `AllSquash` (everyone is mapped to anonymous user)
*
* @return builder
*
*/
public Builder squash(@Nullable Output squash) {
$.squash = squash;
return this;
}
/**
* @param squash Maps a user to anonymous user. Defaults to `RootSquash`. Valid values: `RootSquash` (only root is mapped to anonymous user), `NoSquash` (no one is mapped to anonymous user), `AllSquash` (everyone is mapped to anonymous user)
*
* @return builder
*
*/
public Builder squash(String squash) {
return squash(Output.of(squash));
}
/**
* @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 vpcEndpointDnsName The DNS name of the VPC endpoint for S3 PrivateLink.
*
* @return builder
*
*/
public Builder vpcEndpointDnsName(@Nullable Output vpcEndpointDnsName) {
$.vpcEndpointDnsName = vpcEndpointDnsName;
return this;
}
/**
* @param vpcEndpointDnsName The DNS name of the VPC endpoint for S3 PrivateLink.
*
* @return builder
*
*/
public Builder vpcEndpointDnsName(String vpcEndpointDnsName) {
return vpcEndpointDnsName(Output.of(vpcEndpointDnsName));
}
public NfsFileShareArgs build() {
if ($.clientLists == null) {
throw new MissingRequiredPropertyException("NfsFileShareArgs", "clientLists");
}
if ($.gatewayArn == null) {
throw new MissingRequiredPropertyException("NfsFileShareArgs", "gatewayArn");
}
if ($.locationArn == null) {
throw new MissingRequiredPropertyException("NfsFileShareArgs", "locationArn");
}
if ($.roleArn == null) {
throw new MissingRequiredPropertyException("NfsFileShareArgs", "roleArn");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy