[ aws . s3files ]

create-file-system

Description

Creates an S3 File System resource scoped to a bucket or prefix within a bucket, enabling file system access to S3 data. To create a file system, you need an S3 bucket and an IAM role that grants the service permission to access the bucket.

See also: AWS API Documentation

Synopsis

  create-file-system
--bucket <value>
[--prefix <value>]
[--client-token <value>]
[--kms-key-id <value>]
--role-arn <value>
[--tags <value>]
[--accept-bucket-warning | --no-accept-bucket-warning]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--bucket (string) [required]

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.

Constraints:

• pattern: (arn:aws[a-zA-Z0-9-]*:s3:::.+)

--prefix (string)

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.

Constraints:

• min: 0
• max: 1024
• pattern: (|.*/)

--client-token (string)

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.

Constraints:

• min: 1
• max: 64
• pattern: (.+)

--kms-key-id (string)

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.

Constraints:

• min: 0
• max: 2048
• pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))

--role-arn (string) [required]

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.

Constraints:

• min: 0
• max: 2048
• pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

--tags (list)

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.

Constraints:

• min: 1
• max: 50

(structure)

A key-value pair for resource tagging.

key -> (string) [required]

The tag key. The key can’t start with aws: .

Constraints:

• min: 1
• max: 128
• pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]+)

value -> (string) [required]

The tag value.

Constraints:

• min: 0
• max: 256
• pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--accept-bucket-warning | --no-accept-bucket-warning (boolean)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

creationTime -> (timestamp)

The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time).

fileSystemArn -> (string)

The ARN for the S3 file system, in the format arn:aws:s3files:region:account-id:file-system/file-system-id .

Constraints:

• pattern: (arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40})

fileSystemId -> (string)

The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls.

Constraints:

• min: 0
• max: 128
• pattern: (arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})

bucket -> (string)

The Amazon Resource Name (ARN) of the S3 bucket associated with the file system.

Constraints:

• pattern: (arn:aws[a-zA-Z0-9-]*:s3:::.+)

prefix -> (string)

The prefix within the S3 bucket that scopes the file system access.

clientToken -> (string)

The client token used for idempotency.

Constraints:

• min: 1
• max: 64
• pattern: (.+)

kmsKeyId -> (string)

The ARN or alias of the KMS key used for encryption.

Constraints:

• min: 0
• max: 2048
• pattern: ([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))

status -> (string)

The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated).

Possible values:

• available
• creating
• deleting
• deleted
• error
• updating

statusMessage -> (string)

Additional information about the file system status. This field provides more details when the status is ERROR , or during state transitions.

roleArn -> (string)

The ARN of the IAM role used for S3 access.

Constraints:

• min: 0
• max: 2048
• pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

ownerId -> (string)

The Amazon Web Services account ID of the file system owner.

Constraints:

• min: 0
• max: 12
• pattern: (\d{12})|(\d{4}-{4}-\d{4})

tags -> (list)

The tags associated with the file system.

Constraints:

• min: 1
• max: 50

(structure)

A key-value pair for resource tagging.

key -> (string) [required]

The tag key. The key can’t start with aws: .

Constraints:

• min: 1
• max: 128
• pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]+)

value -> (string) [required]

The tag value.

Constraints:

• min: 0
• max: 256
• pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

name -> (string)

The name of the file system, derived from the Name tag if present.

Constraints:

• min: 0
• max: 256
• pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)