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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Describes an Amazon Lightsail bucket.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#able_to_update_bundleBoolean

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 AWS billing cycle.

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

Returns:

  • (Boolean)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#access_rulesTypes::AccessRules

An object that describes the access rules of the bucket.

Returns:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) of the bucket.

Returns:

  • (String)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#bundle_idString

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)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The timestamp when the distribution was created.

Returns:

  • (Time)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#locationTypes::ResourceLocation

Describes the resource location.



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the bucket.

Returns:

  • (String)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#object_versioningString

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)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#readonly_access_accountsArray<String>

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

Returns:

  • (Array<String>)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

The Lightsail resource type of the bucket (for example, Bucket).

Returns:

  • (String)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#resources_receiving_accessArray<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:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#stateTypes::BucketState

An object that describes the state of the bucket.

Returns:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#support_codeString

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)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

The URL of the bucket.

Returns:

  • (String)


1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1060

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)
  SENSITIVE = []
  include Aws::Structure
end