Class: AWSCDK::S3::BlockPublicAccess

Inherits:
Jsii::Object
  • Object
show all
Defined in:
s3/block_public_access.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BlockPublicAccess

Returns a new instance of BlockPublicAccess.

Parameters:



8
9
10
11
12
 
# File 's3/block_public_access.rb', line 8

def initialize(options)
  options = options.is_a?(Hash) ? ::AWSCDK::S3::BlockPublicAccessOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuQmxvY2tQdWJsaWNBY2Nlc3NPcHRpb25zIn0=")), "options")
  Jsii::Object.instance_method(:initialize).bind(self).call(options)
end

Class Method Details

.BLOCK_ACLS ⇒ AWSCDK::S3::BlockPublicAccess

Deprecated.

Use BLOCK_ACLS_ONLY instead.

Returns:

  • (AWSCDK::S3::BlockPublicAccess) 


25
26
27
 
# File 's3/block_public_access.rb', line 25

def self.BLOCK_ACLS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_s3.BlockPublicAccess", "BLOCK_ACLS")
end

.BLOCK_ACLS_ONLY ⇒ AWSCDK::S3::BlockPublicAccess

Use this option if you want to only block the ACLs, using this will set blockPublicPolicy and restrictPublicBuckets to false.

Returns:

  • (AWSCDK::S3::BlockPublicAccess) 


32
33
34
 
# File 's3/block_public_access.rb', line 32

def self.BLOCK_ACLS_ONLY()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_s3.BlockPublicAccess", "BLOCK_ACLS_ONLY")
end

.BLOCK_ALL ⇒ AWSCDK::S3::BlockPublicAccess

Use this option if you want to ensure every public access method is blocked.

However keep in mind that this is the default state of an S3 bucket, and leaving blockPublicAccess undefined would also work.

Returns:

  • (AWSCDK::S3::BlockPublicAccess) 


41
42
43
 
# File 's3/block_public_access.rb', line 41

def self.BLOCK_ALL()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_s3.BlockPublicAccess", "BLOCK_ALL")
end

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 's3/block_public_access.rb', line 14

def self.jsii_overridable_methods
  {
    :block_public_acls => { kind: :property, name: "blockPublicAcls", is_optional: true },
    :block_public_policy => { kind: :property, name: "blockPublicPolicy", is_optional: true },
    :ignore_public_acls => { kind: :property, name: "ignorePublicAcls", is_optional: true },
    :restrict_public_buckets => { kind: :property, name: "restrictPublicBuckets", is_optional: true },
  }
end

Instance Method Details

#block_public_acls ⇒ Boolean?

Returns:

  • (Boolean, nil) 


46
47
48
 
# File 's3/block_public_access.rb', line 46

def block_public_acls()
  jsii_get_property("blockPublicAcls")
end

#block_public_acls=(value) ⇒ Object 



50
51
52
53
 
# File 's3/block_public_access.rb', line 50

def block_public_acls=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "blockPublicAcls") unless value.nil?
  jsii_set_property("blockPublicAcls", value)
end

#block_public_policy ⇒ Boolean?

Returns:

  • (Boolean, nil) 


56
57
58
 
# File 's3/block_public_access.rb', line 56

def block_public_policy()
  jsii_get_property("blockPublicPolicy")
end

#block_public_policy=(value) ⇒ Object 



60
61
62
63
 
# File 's3/block_public_access.rb', line 60

def block_public_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "blockPublicPolicy") unless value.nil?
  jsii_set_property("blockPublicPolicy", value)
end

#ignore_public_acls ⇒ Boolean?

Returns:

  • (Boolean, nil) 


66
67
68
 
# File 's3/block_public_access.rb', line 66

def ignore_public_acls()
  jsii_get_property("ignorePublicAcls")
end

#ignore_public_acls=(value) ⇒ Object 



70
71
72
73
 
# File 's3/block_public_access.rb', line 70

def ignore_public_acls=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "ignorePublicAcls") unless value.nil?
  jsii_set_property("ignorePublicAcls", value)
end

#restrict_public_buckets ⇒ Boolean?

Returns:

  • (Boolean, nil) 


76
77
78
 
# File 's3/block_public_access.rb', line 76

def restrict_public_buckets()
  jsii_get_property("restrictPublicBuckets")
end

#restrict_public_buckets=(value) ⇒ Object 



80
81
82
83
 
# File 's3/block_public_access.rb', line 80

def restrict_public_buckets=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "restrictPublicBuckets") unless value.nil?
  jsii_set_property("restrictPublicBuckets", value)
end