Class: Awspec::Type::S3Bucket

Inherits:
Base
  • Object
show all
Defined in:
lib/awspec/type/s3_bucket.rb

Constant Summary

Constants included from Helper::Finder

Helper::Finder::CLIENTS

Instance Attribute Summary

Attributes inherited from Base

#id, #resource_via_client

Instance Method Summary collapse

Methods inherited from Base

aws_resource, #exists?, #inspect, #method_missing, #to_s

Methods included from BlackListForwardable

#method_missing_via_black_list

Methods included from Helper::Finder::Ami

#find_ami

Methods included from Helper::Finder::Directconnect

#find_virtual_interface, #select_virtual_interfaces

Methods included from Helper::Finder::Ses

#find_ses_identity

Methods included from Helper::Finder::Cloudwatch

#find_cloudwatch_alarm, #select_all_cloudwatch_alarms

Methods included from Helper::Finder::Elasticache

#find_cache_cluster, #find_cache_subnet_group

Methods included from Helper::Finder::Iam

#select_all_attached_policies, #select_attached_entities, #select_attached_groups, #select_attached_roles, #select_attached_users, #select_iam_group_by_user_name, #select_iam_policy_by_group_name, #select_iam_policy_by_role_name, #select_iam_policy_by_user_name, #select_policy_evaluation_results

Methods included from Helper::Finder::Lambda

#find_lambda, #select_event_source_by_function_arn

Methods included from Helper::Finder::Elb

#find_elb, #select_elb_by_vpc_id

Methods included from Helper::Finder::Ebs

#find_ebs, #select_all_attached_ebs, #select_ebs_by_instance_id

Methods included from Helper::Finder::Autoscaling

#find_autoscaling_group, #find_launch_configuration

Methods included from Helper::Finder::S3

#find_bucket, #find_bucket_acl, #find_bucket_cors, #find_bucket_policy, #select_all_buckets

Methods included from Helper::Finder::Route53

#find_hosted_zone, #select_record_sets_by_hosted_zone_id

Methods included from Helper::Finder::Rds

#find_rds, #select_rds_by_vpc_id

Methods included from Helper::Finder::SecurityGroup

#find_security_group, #select_security_group_by_vpc_id

Methods included from Helper::Finder::Ec2

#find_ec2, #find_ec2_attribute, #find_nat_gateway, #find_security_group, #select_ec2_by_vpc_id, #select_eip_by_instance_id, #select_nat_gateway_by_vpc_id

Methods included from Helper::Finder::Vpc

#find_network_acl, #find_route_table, #find_subnet, #find_vpc, #find_vpc_peering_connection, #select_network_acl_by_vpc_id, #select_route_table_by_vpc_id, #select_subnet_by_vpc_id

Constructor Details

#initialize(id) ⇒ S3Bucket

Returns a new instance of S3Bucket.



5
6
7
8
9
 
# File 'lib/awspec/type/s3_bucket.rb', line 5

def initialize(id)
  super
  @resource_via_client = find_bucket(id)
  @id = id if @resource_via_client
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Awspec::Type::Base

Instance Method Details

#acl_grants_count ⇒ Object 



34
35
36
37
 
# File 'lib/awspec/type/s3_bucket.rb', line 34

def acl_grants_count
  @acl = find_bucket_acl(@id)
  @acl.grants.count
end

#acl_owner ⇒ Object 



29
30
31
32
 
# File 'lib/awspec/type/s3_bucket.rb', line 29

def acl_owner
  @acl = find_bucket_acl(@id)
  @acl.owner.display_name
end

#cors_rules_count ⇒ Object 



53
54
55
 
# File 'lib/awspec/type/s3_bucket.rb', line 53

def cors_rules_count
  cors_rules.count
end

#has_acl_grant?(grantee:, permission:) ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
24
25
26
27
 
# File 'lib/awspec/type/s3_bucket.rb', line 21

def has_acl_grant?(grantee:, permission:)
  @acl = find_bucket_acl(@id)
  @acl.grants.find do |grant|
    grant.permission == permission &&
      (grant.grantee.display_name == grantee || grant.grantee.uri == grantee || grant.grantee.id == grantee)
  end
end

#has_cors_rule?(allowed_headers: [], allowed_methods:, allowed_origins:, expose_headers: [], max_age_seconds: nil) ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/awspec/type/s3_bucket.rb', line 39

def has_cors_rule?(allowed_headers: [],
                   allowed_methods:,
                   allowed_origins:,
                   expose_headers: [],
                   max_age_seconds: nil)
  cors_rules.any? do |rule|
    (rule.allowed_headers - allowed_headers).empty? &&
      (rule.allowed_methods - allowed_methods).empty? &&
      (rule.allowed_origins - allowed_origins).empty? &&
      (rule.expose_headers - expose_headers).empty? &&
      rule.max_age_seconds == max_age_seconds
  end
end

#has_object?(key) ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
14
15
16
17
18
19
 
# File 'lib/awspec/type/s3_bucket.rb', line 11

def has_object?(key)
  res = s3_client.head_object({
                                bucket: @id,
                                key: key.sub(%r(\A/), '')
                              })
  res
rescue
  false
end

#has_policy?(policy) ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
60
61
 
# File 'lib/awspec/type/s3_bucket.rb', line 57

def has_policy?(policy)
  bp = find_bucket_policy(@id)
  # newlines, spaces, etc.. are removed from policy which is returned from API
  bp ? (bp.policy.read == policy.gsub(/(\n|\r|\r\n|\s|\t)/, '')) : false
end