Class: Aws::S3Files::Types::CreateFileSystemResponse

Inherits:

Struct

• Object
• Struct
• Aws::S3Files::Types::CreateFileSystemResponse

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3files/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

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

• #client_token ⇒ String

  The client token used for idempotency.

• #creation_time ⇒ Time

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

• #file_system_arn ⇒ String

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

• #file_system_id ⇒ String

  The ID of the file system, assigned by S3 Files.

• #kms_key_id ⇒ String

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

• #name ⇒ String

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

• #owner_id ⇒ String

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

• #prefix ⇒ String

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

• #role_arn ⇒ String

  The ARN of the IAM role used for S3 access.

• #status ⇒ String

  The lifecycle state of the file system.

• #status_message ⇒ String

  Additional information about the file system status.

• #tags ⇒ Array<Types::Tag>

  The tags associated with the file system.

Instance Attribute Details

#bucket ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

The client token used for idempotency.

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM role used for S3 access.

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#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).

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags associated with the file system.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-s3files/types.rb', line 272

class CreateFileSystemResponse < Struct.new(
  :creation_time,
  :file_system_arn,
  :file_system_id,
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :status,
  :status_message,
  :role_arn,
  :owner_id,
  :tags,
  :name)
  SENSITIVE = []
  include Aws::Structure
end