create_nfs_file_share async ¶

async def create_nfs_file_share(
    self,
    client_token: "capo_storage_gateway.types.client_token.ClientToken",
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    role: "capo_storage_gateway.types.role.Role",
    location_arn: "capo_storage_gateway.types.location_arn.LocationARN",
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    nfs_file_share_defaults: Optional[
        "capo_storage_gateway.types.nfs_file_share_defaults.NFSFileShareDefaults"
    ] = None,
    encryption_type: Optional[
        "capo_storage_gateway.types.encryption_type.EncryptionType"
    ] = None,
    kms_encrypted: Optional["capo_storage_gateway.types.boolean.Boolean"] = None,
    kms_key: Optional["capo_storage_gateway.types.kms_key.KMSKey"] = None,
    default_storage_class: Optional[
        "capo_storage_gateway.types.storage_class.StorageClass"
    ] = None,
    object_acl: Optional["capo_storage_gateway.types.object_acl.ObjectACL"] = None,
    client_list: Optional[
        "capo_storage_gateway.types.file_share_client_list.FileShareClientList"
    ] = None,
    squash: Optional["capo_storage_gateway.types.squash.Squash"] = None,
    read_only: Optional["capo_storage_gateway.types.boolean.Boolean"] = None,
    guess_mime_type_enabled: Optional[
        "capo_storage_gateway.types.boolean.Boolean"
    ] = None,
    requester_pays: Optional["capo_storage_gateway.types.boolean.Boolean"] = None,
    tags: Optional["capo_storage_gateway.types.tags.Tags"] = None,
    file_share_name: Optional[
        "capo_storage_gateway.types.file_share_name.FileShareName"
    ] = None,
    cache_attributes: Optional[
        "capo_storage_gateway.types.cache_attributes.CacheAttributes"
    ] = None,
    notification_policy: Optional[
        "capo_storage_gateway.types.notification_policy.NotificationPolicy"
    ] = None,
    vpc_endpoint_dns_name: Optional[
        "capo_storage_gateway.types.dns_host_name.DNSHostName"
    ] = None,
    bucket_region: Optional["capo_storage_gateway.types.region_id.RegionId"] = None,
    audit_destination_arn: Optional[
        "capo_storage_gateway.types.audit_destination_arn.AuditDestinationARN"
    ] = None,
) -> "capo_storage_gateway.types.create_nfs_file_share_output.CreateNFSFileShareOutput":
    r"""<p>Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation is only supported for S3 File Gateways.</p> <important> <p>S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>Identity and Access Management User Guide</i>.</p> <p>S3 File Gateways do not support creating hard or symbolic links on a file share.</p> </important>

    Args:
        client_token: <p>A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.</p>
        nfs_file_share_defaults: <p>File share default values. Optional.</p>
        gateway_arn: <p>The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.</p>
        encryption_type: <p>A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.</p> <note> <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p> <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p> </note>
        kms_encrypted: <p>Optional. Set to <code>true</code> to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or <code>false</code> to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the <code>EncryptionType</code> parameter instead.</p> <note> <p>We recommend using <code>EncryptionType</code> instead of <code>KMSEncrypted</code> to set the file share encryption method. You do not need to provide values for both parameters.</p> <p>If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if <code>EncryptionType</code> is <code>SseS3</code>, then <code>KMSEncrypted</code> must be <code>false</code>. If <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>, then <code>KMSEncrypted</code> must be <code>true</code>.</p> </note> <p>Valid Values: <code>true</code> | <code>false</code> </p>
        kms_key: <p>Optional. The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value must be set if <code>KMSEncrypted</code> is <code>true</code>, or if <code>EncryptionType</code> is <code>SseKms</code> or <code>DsseKms</code>.</p>
        role: <p>The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.</p>
        location_arn: <p>A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).</p> <note> <p>You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.</p> <p>Bucket ARN:</p> <p> <code>arn:aws:s3:::amzn-s3-demo-bucket/prefix/</code> </p> <p>Access point ARN:</p> <p> <code>arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/</code> </p> <p>If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control">Delegating access control to access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Access point alias:</p> <p> <code>test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias</code> </p> </note>
        default_storage_class: <p>The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p> <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> | <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code> </p>
        object_acl: <p>A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is <code>private</code>.</p>
        client_list: <p>The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IPv4/IPv6 addresses or valid CIDR blocks.</p>
        squash: <p>A value that maps a user to anonymous user.</p> <p>Valid values are the following:</p> <ul> <li> <p> <code>RootSquash</code>: Only root is mapped to anonymous user.</p> </li> <li> <p> <code>NoSquash</code>: No one is mapped to anonymous user.</p> </li> <li> <p> <code>AllSquash</code>: Everyone is mapped to anonymous user.</p> </li> </ul>
        read_only: <p>A value that sets the write status of a file share. Set this value to <code>true</code> to set the write status to read-only, otherwise set to <code>false</code>.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>
        guess_mime_type_enabled: <p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to <code>true</code> to enable MIME type guessing, otherwise set to <code>false</code>. The default value is <code>true</code>.</p> <p>Valid Values: <code>true</code> | <code>false</code> </p>
        requester_pays: <p>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to <code>true</code>, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</p> <note> <p> <code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</p> </note> <p>Valid Values: <code>true</code> | <code>false</code> </p>
        tags: <p>A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</p> </note>
        file_share_name: <p>The name of the file share. Optional.</p> <note> <p> <code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>, or if an access point or access point alias is used.</p> <p>A valid NFS file share name can only contain the following characters: <code>a</code>-<code>z</code>, <code>A</code>-<code>Z</code>, <code>0</code>-<code>9</code>, <code>-</code>, <code>.</code>, and <code>_</code>.</p> </note>
        cache_attributes: <p>Specifies refresh cache information for the file share.</p>
        notification_policy: <p>The notification policy of the file share. <code>SettlingTimeInSeconds</code> controls the number of seconds to wait after the last point in time a client wrote to a file before generating an <code>ObjectUploaded</code> notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.</p> <note> <p> <code>SettlingTimeInSeconds</code> has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.</p> <p>This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.</p> </note> <p>The following example sets <code>NotificationPolicy</code> on with <code>SettlingTimeInSeconds</code> set to 60.</p> <p> <code>{\"Upload\": {\"SettlingTimeInSeconds\": 60}}</code> </p> <p>The following example sets <code>NotificationPolicy</code> off.</p> <p> <code>{}</code> </p>
        vpc_endpoint_dns_name: <p>Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.</p> <note> <p>This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.</p> </note>
        bucket_region: <p>Specifies the Region of the S3 bucket where the NFS file share stores files.</p> <note> <p>This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.</p> </note>
        audit_destination_arn: <p>The Amazon Resource Name (ARN) of the storage used for audit logs.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.create_nfs_file_share_input.CreateNFSFileShareInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.create_nfs_file_share_output.CreateNFSFileShareOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.create_nfs_file_share

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.create_nfs_file_share.async_create_nfs_file_share(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateNFSFileShare")
    )
    input_: capo_storage_gateway.types.create_nfs_file_share_input.CreateNFSFileShareInput = {
        "client_token": client_token,
        "gateway_arn": gateway_arn,
        "role": role,
        "location_arn": location_arn,
    }
    if nfs_file_share_defaults is not None:
        input_["nfs_file_share_defaults"] = nfs_file_share_defaults
    if encryption_type is not None:
        input_["encryption_type"] = encryption_type
    if kms_encrypted is not None:
        input_["kms_encrypted"] = kms_encrypted
    if kms_key is not None:
        input_["kms_key"] = kms_key
    if default_storage_class is not None:
        input_["default_storage_class"] = default_storage_class
    if object_acl is not None:
        input_["object_acl"] = object_acl
    if client_list is not None:
        input_["client_list"] = client_list
    if squash is not None:
        input_["squash"] = squash
    if read_only is not None:
        input_["read_only"] = read_only
    if guess_mime_type_enabled is not None:
        input_["guess_mime_type_enabled"] = guess_mime_type_enabled
    if requester_pays is not None:
        input_["requester_pays"] = requester_pays
    if tags is not None:
        input_["tags"] = tags
    if file_share_name is not None:
        input_["file_share_name"] = file_share_name
    if cache_attributes is not None:
        input_["cache_attributes"] = cache_attributes
    if notification_policy is not None:
        input_["notification_policy"] = notification_policy
    if vpc_endpoint_dns_name is not None:
        input_["vpc_endpoint_dns_name"] = vpc_endpoint_dns_name
    if bucket_region is not None:
        input_["bucket_region"] = bucket_region
    if audit_destination_arn is not None:
        input_["audit_destination_arn"] = audit_destination_arn

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output