Class: Aws::Lightsail::Types::Bucket

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::Bucket

Defined in:

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

Overview

Describes an Amazon Lightsail bucket.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #able_to_update_bundle ⇒ Boolean

  Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

• #access_log_config ⇒ Types::BucketAccessLogConfig

  An object that describes the access log configuration for the bucket.

• #access_rules ⇒ Types::AccessRules

  An object that describes the access rules of the bucket.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the bucket.

• #bundle_id ⇒ String

  The ID of the bundle currently applied to the bucket.

• #cors ⇒ Types::BucketCorsConfig

  An array of cross-origin resource sharing (CORS) rules that identify origins and the HTTP methods that can be executed on your bucket.

• #created_at ⇒ Time

  The timestamp when the distribution was created.

• #location ⇒ Types::ResourceLocation

  An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

• #name ⇒ String

  The name of the bucket.

• #object_versioning ⇒ String

  Indicates whether object versioning is enabled for the bucket.

• #readonly_access_accounts ⇒ Array<String>

  An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

• #resource_type ⇒ String

  The Lightsail resource type of the bucket.

• #resources_receiving_access ⇒ Array<Types::ResourceReceivingAccess>

  An array of objects that describe Lightsail instances that have access to the bucket.

• #state ⇒ Types::BucketState

  An object that describes the state of the bucket.

• #support_code ⇒ String

  The support code for a bucket.

• #tags ⇒ Array<Types::Tag>

  The tag keys and optional values for the bucket.

• #url ⇒ String

  The URL of the bucket.

Instance Attribute Details

#able_to_update_bundle ⇒ Boolean

Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle.

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle.

Use the UpdateBucketBundle action to change a bucket's bundle.

Returns:

• (Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#access_log_config ⇒ Types::BucketAccessLogConfig

An object that describes the access log configuration for the bucket.

Returns:

• (Types::BucketAccessLogConfig)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#access_rules ⇒ Types::AccessRules

An object that describes the access rules of the bucket.

Returns:

• (Types::AccessRules)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the bucket.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#bundle_id ⇒ String

The ID of the bundle currently applied to the bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to change the bundle of a bucket.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#cors ⇒ Types::BucketCorsConfig

An array of cross-origin resource sharing (CORS) rules that identify origins and the HTTP methods that can be executed on your bucket. This field is only included in the response when CORS configuration is requested or when updating CORS configuration. For more information, see Configuring cross-origin resource sharing (CORS).

Returns:

• (Types::BucketCorsConfig)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the distribution was created.

Returns:

• (Time)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::ResourceLocation

An object that describes the location of the bucket, such as the Amazon Web Services Region and Availability Zone.

Returns:

• (Types::ResourceLocation)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the bucket.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#object_versioning ⇒ String

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

• Enabled - Object versioning is enabled.

• Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

• NeverEnabled - Object versioning has never been enabled.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#readonly_access_accounts ⇒ Array<String>

An array of strings that specify the Amazon Web Services account IDs that have read-only access to the bucket.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The Lightsail resource type of the bucket.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#resources_receiving_access ⇒ Array<Types::ResourceReceivingAccess>

An array of objects that describe Lightsail instances that have access to the bucket.

Use the SetResourceAccessForBucket action to update the instances that have access to a bucket.

Returns:

• (Array<Types::ResourceReceivingAccess>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::BucketState

An object that describes the state of the bucket.

Returns:

• (Types::BucketState)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#support_code ⇒ String

The support code for a bucket. Include this code in your email to support when you have questions about a Lightsail bucket. This code enables our support team to look up your Lightsail information more easily.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tag keys and optional values for the bucket. For more information, see Tags in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

The URL of the bucket.

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1178

class Bucket < Struct.new(
  :resource_type,
  :access_rules,
  :arn,
  :bundle_id,
  :created_at,
  :url,
  :location,
  :name,
  :support_code,
  :tags,
  :object_versioning,
  :able_to_update_bundle,
  :readonly_access_accounts,
  :resources_receiving_access,
  :state,
  :access_log_config,
  :cors)
  SENSITIVE = []
  include Aws::Structure
end