Class: Awspec::Type::S3Bucket

Inherits:
ResourceBase show all
Defined in:
lib/awspec/type/s3_bucket.rb

Constant Summary

Constants included from Helper::Finder

Helper::Finder::CLIENTS, Helper::Finder::CLIENT_OPTIONS

Instance Attribute Summary

Attributes inherited from Base

#account

Instance Method Summary collapse

Methods inherited from ResourceBase

aws_resource, #exists?, #initialize

Methods inherited from Base

#inspect, #method_missing, #respond_to_missing?, tags_allowed, #to_s

Methods included from BlackListForwardable

#method_missing_via_black_list

Methods included from Helper::Finder::CognitoIdentityPool

#find_identitypool_by_name

Methods included from Helper::Finder::Msk

#find_msk_cluster_by_name

Methods included from Helper::Finder::CognitoUserPool

#find_userpool_by_name

Methods included from Helper::Finder::Secretsmanager

#find_secret

Methods included from Helper::Finder::Mq

#find_broker

Methods included from Helper::Finder::Codedeploy

#find_codedeploy_app, #find_codedeploy_deployment_group

Methods included from Helper::Finder::Redshift

#find_redshift_cluster_identifier, #select_all_redshift_cluster_parameters, #select_redshift_by_vpc_id

Methods included from Helper::Finder::Emr

#find_emr_cluster

Methods included from Helper::Finder::SNSTopic

#find_sns_topic, #find_sns_topic_subs

Methods included from Helper::Finder::Eks

#find_eks_cluster

Methods included from Helper::Finder::Batch

#find_batch_compute_environment, #find_batch_job_definition, #find_batch_job_queue

Methods included from Helper::Finder::Kinesis

#find_kinesis_by_stream_name

Methods included from Helper::Finder::Apigateway

#find_api_resources_by_id, #find_apigateway_by_id, #find_apigateway_by_name

Methods included from Helper::Finder::Codebuild

#find_codebuild_project, #select_all_codebuild_projects

Methods included from Helper::Finder::Cloudformation

#find_cloudformation_stack

Methods included from Helper::Finder::SsmParameter

#find_parameter_tag, #find_ssm_parameter

Methods included from Helper::Finder::Sqs

#find_queue, #find_tags_for_queue

Methods included from Helper::Finder::Dynamodb

#find_dynamodb_table

Methods included from Helper::Finder::CloudwatchLogs

#find_cloudwatch_logs_group, #find_cloudwatch_logs_metric_fileter_by_log_group_name, #find_cloudwatch_logs_stream_by_log_group_name, #find_cloudwatch_logs_subscription_fileter_by_log_group_name, #find_tags_by_log_group_name, #last_cloudwatch_logs_stream_by_log_group_name, #select_all_cloudwatch_logs_log_groups

Methods included from Helper::Finder::AccountAttributes

#find_ec2_account_attributes, #find_lambda_account_settings, #find_rds_account_attributes, #find_ses_send_quota

Methods included from Helper::Finder::Acm

#find_certificate, #select_all_certificates

Methods included from Helper::Finder::WafRegional

#find_wafregional_ip_set, #find_wafregional_rule, #find_wafregional_web_acl

Methods included from Helper::Finder::Waf

#find_waf_ip_set, #find_waf_rule, #find_waf_web_acl

Methods included from Helper::Finder::Cloudtrail

#find_trail, #get_trail_status, #get_trail_tags, #is_logging?, #select_all_trails

Methods included from Helper::Finder::Elastictranscoder

#find_pipeline

Methods included from Helper::Finder::Cloudfront

#find_cloudfront_distribution

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::CloudwatchEvent

#find_cloudwatch_event, #select_all_cloudwatch_events

Methods included from Helper::Finder::Cloudwatch

#find_cloudwatch_alarm, #select_all_cloudwatch_alarms

Methods included from Helper::Finder::Elasticsearch

#find_elasticsearch_domain, #select_all_elasticsearch_domains

Methods included from Helper::Finder::Elasticache

#find_cache_cluster, #find_cache_subnet_group

Methods included from Helper::Finder::Kms

#find_kms_key, #find_kms_key_by_alias, #select_all_kms_aliases

Methods included from Helper::Finder::Iam

#select_all_attached_policies, #select_all_iam_groups, #select_all_iam_roles, #select_all_iam_users, #select_attached_entities, #select_attached_groups, #select_attached_roles, #select_attached_users, #select_iam_group_by_user_name, #select_policy_evaluation_results

Methods included from Helper::Finder::Lambda

#find_lambda, #select_all_lambda_functions, #select_event_source_by_function_arn

Methods included from Helper::Finder::Elb

#find_elb, #find_elb_attribute, #select_all_elb_tags, #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_block_device_mapping, #find_launch_configuration, #select_alb_target_group_by_autoscaling_group_name, #select_autoscaling_group_by_vpc_id, #select_lb_target_group_by_autoscaling_group_name

Methods included from Helper::Finder::S3

#find_bucket, #find_bucket_acl, #find_bucket_cors, #find_bucket_lifecycle_configuration, #find_bucket_logging, #find_bucket_policy, #find_bucket_server_side_encryption, #find_bucket_tag, #find_bucket_versioning, #head_object, #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_all_rds_db_cluster_parameters, #select_all_rds_db_parameters, #select_rds_by_vpc_id

Methods included from Helper::Finder::SecurityGroup

#describe_security_groups, #find_security_group, #select_security_group_by_group_id, #select_security_group_by_group_name, #select_security_group_by_tag_name, #select_security_group_by_vpc_id

Methods included from Helper::Finder::Firehose

#find_delivery_stream

Methods included from Helper::Finder::Efs

#find_efs, #find_efs_tags, #get_id_by_name_tag, #get_name_by_id, #select_all_file_systems

Methods included from Helper::Finder::Ecs

#find_ecs_cluster, #find_ecs_container_instance, #find_ecs_container_instances, #find_ecs_service, #find_ecs_task_definition, #select_ecs_container_instance_arn_by_cluster_name

Methods included from Helper::Finder::Ecr

#find_ecr_repository, #get_policy_text

Methods included from Helper::Finder::Ec2

#find_ec2, #find_ec2_attribute, #find_ec2_credit_specifications, #find_ec2_status, #find_launch_template, #find_launch_template_versions, #find_nat_gateway, #find_network_interface, #find_tgw_attachments_by_tgw_id, #find_vpn_connection, #select_ec2_by_vpc_id, #select_eip_by_instance_id, #select_eip_by_public_ip, #select_internet_gateway_by_vpc_id, #select_nat_gateway_by_vpc_id, #select_network_interface_by_instance_id, #select_network_interface_by_vpc_id

Methods included from Helper::Finder::Subnet

#find_subnet, #select_subnet_by_vpc_id

Methods included from Helper::Finder::VpcEndpoints

#find_vpc_endpoint

Methods included from Helper::Finder::Vpc

#find_network_acl, #find_route_table, #find_vpc, #find_vpc_attribute, #find_vpc_peering_connection, #select_network_acl_by_vpc_id, #select_route_table_by_vpc_id, #select_vpc_attribute, #select_vpc_peering_connection_by_vpc_id

Methods included from Helper::Finder::Alb

#find_alb, #find_alb_listener, #find_alb_target_group, #select_alb_by_vpc_id, #select_alb_listener_by_alb_arn, #select_all_alb_tags, #select_rule_by_alb_listener_id

Methods included from Helper::Finder::Nlb

#find_nlb, #find_nlb_listener, #find_nlb_target_group, #select_nlb_by_vpc_id, #select_nlb_listener_by_nlb_arn, #select_rule_by_nlb_listener_id

Constructor Details

This class inherits a constructor from Awspec::Type::ResourceBase

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 



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

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

#acl_owner ⇒ Object 



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

def acl_owner
  check_existence
  @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) 


18
19
20
21
22
23
24
25
 
# File 'lib/awspec/type/s3_bucket.rb', line 18

def has_acl_grant?(grantee:, permission:)
  check_existence
  @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_lifecycle_rule?(rule) ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/awspec/type/s3_bucket.rb', line 92

def has_lifecycle_rule?(rule)
  check_existence
  lc_rule = lifecycle_configuration_rules.select { |r| r[:id] == rule[:id] }
  return false if lc_rule == []

  rule.all? do |key, value|
    lc_rule.each do |r|
      return false if value.is_a?(String) && r[key] != value
      if value.is_a?(Hash)
        return false if r[key].to_h != value
      end
      if value.is_a?(Array)
        return false if r[key].map(&:to_h) != value
      end
      true
    end
  end
end

#has_logging_enabled?(target_bucket: nil, target_prefix: nil) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
78
79
80
81
82
83
84
 
# File 'lib/awspec/type/s3_bucket.rb', line 75

def has_logging_enabled?(target_bucket: nil, target_prefix: nil)
  check_existence
  bl = find_bucket_logging(id)
  le = bl ? bl.logging_enabled : nil

  return false if le.nil?
  return false if target_bucket && target_bucket != le.target_bucket
  return false if target_prefix && target_prefix != le.target_prefix
  true
end

#has_mfa_delete_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
114
115
 
# File 'lib/awspec/type/s3_bucket.rb', line 111

def has_mfa_delete_enabled?
  check_existence
  bv = find_bucket_versioning(id)
  bv ? (bv.mfa_delete == 'Enabled') : false
end

#has_object?(key) ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
16
 
# File 'lib/awspec/type/s3_bucket.rb', line 13

def has_object?(key)
  check_existence
  head_object(id, key)
end

#has_policy?(policy) ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
60
61
62
63
64
65
66
 
# File 'lib/awspec/type/s3_bucket.rb', line 57

def has_policy?(policy)
  check_existence
  bp = find_bucket_policy(id)

  if bp
    JSON.parse(bp.policy.read, array_class: Set) == JSON.parse(policy, array_class: Set)
  else
    false
  end
end

#has_server_side_encryption?(algorithm:) ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
120
121
122
123
124
 
# File 'lib/awspec/type/s3_bucket.rb', line 117

def has_server_side_encryption?(algorithm:)
  check_existence
  configuration = find_bucket_server_side_encryption(id)
  return false unless configuration

  sse_algorithm = configuration.rules[0].apply_server_side_encryption_by_default.sse_algorithm
  sse_algorithm ? (sse_algorithm == algorithm) : false
end

#has_tag?(key, value) ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
71
72
73
 
# File 'lib/awspec/type/s3_bucket.rb', line 68

def has_tag?(key, value)
  check_existence
  tag = find_bucket_tag(id, key)
  return nil if tag.value != value
  tag
end

#has_versioning_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
89
90
 
# File 'lib/awspec/type/s3_bucket.rb', line 86

def has_versioning_enabled?
  check_existence
  bv = find_bucket_versioning(id)
  bv ? (bv.status == 'Enabled') : false
end

#id ⇒ Object 



9
10
11
 
# File 'lib/awspec/type/s3_bucket.rb', line 9

def id
  @id ||= @display_name if resource_via_client
end

#resource_via_client ⇒ Object 



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

def resource_via_client
  @resource_via_client ||= find_bucket(@display_name)
end