Class: Aws::S3Files::Types::CreateFileSystemRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3Files::Types::CreateFileSystemRequest

Defined in:

gems/aws-sdk-s3files/lib/aws-sdk-s3files/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accept_bucket_warning ⇒ Boolean

  Set to true to acknowledge and accept any warnings about the bucket configuration.

• #bucket ⇒ String

  The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure idempotent creation.

• #kms_key_id ⇒ String

  The ARN, key ID, or alias of the KMS key to use for encryption.

• #prefix ⇒ String

  An optional prefix within the S3 bucket to scope the file system access.

• #role_arn ⇒ String

  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.

• #tags ⇒ Array<Types::Tag>

  An array of key-value pairs to apply as tags to the file system resource.

Instance Attribute Details

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

Returns:

• (Boolean)

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

class CreateFileSystemRequest < Struct.new(
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :role_arn,
  :tags,
  :accept_bucket_warning)
  SENSITIVE = []
  include Aws::Structure
end

#bucket ⇒ String

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.

Returns:

• (String)

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

class CreateFileSystemRequest < Struct.new(
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :role_arn,
  :tags,
  :accept_bucket_warning)
  SENSITIVE = []
  include Aws::Structure
end

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

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

class CreateFileSystemRequest < Struct.new(
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :role_arn,
  :tags,
  :accept_bucket_warning)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class CreateFileSystemRequest < Struct.new(
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :role_arn,
  :tags,
  :accept_bucket_warning)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class CreateFileSystemRequest < Struct.new(
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :role_arn,
  :tags,
  :accept_bucket_warning)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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.

Returns:

• (String)

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

class CreateFileSystemRequest < Struct.new(
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :role_arn,
  :tags,
  :accept_bucket_warning)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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.

Returns:

• (Array<Types::Tag>)

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

class CreateFileSystemRequest < Struct.new(
  :bucket,
  :prefix,
  :client_token,
  :kms_key_id,
  :role_arn,
  :tags,
  :accept_bucket_warning)
  SENSITIVE = []
  include Aws::Structure
end