Class: AWSCDK::S3::BucketPolicy

Inherits:
Resource
  • Object
show all
Includes:
Interfaces::AWSS3::IBucketPolicyRef
Defined in:
s3/bucket_policy.rb

Overview

The bucket policy for an Amazon S3 bucket.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called add_to_resource_policy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

The bucket policy method is implemented differently than add_to_resource_policy() as BucketPolicy() creates a new policy without knowing one earlier existed. e.g. if during Bucket creation, if autoDeleteObject:true, these policies are added to the bucket policy: ["s3:DeleteObject*", "s3:GetBucket*", "s3:List*", "s3:PutBucketPolicy"], and when you add a new BucketPolicy with ["s3:GetObject", "s3:ListBucket"] on this existing bucket, invoking BucketPolicy() will create a new Policy without knowing one earlier exists already, so it creates a new one. In this case, the custom resource handler will not have access to s3:GetBucketTagging action which will cause failure during deletion of stack.

Hence its strongly recommended to use add_to_resource_policy() method to add new permissions to existing policy.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ BucketPolicy

Returns a new instance of BucketPolicy.

Parameters:



35
36
37
38
39
40
41
 
# File 's3/bucket_policy.rb', line 35

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::S3::BucketPolicyProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuQnVja2V0UG9saWN5UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_cfn_bucket_policy(cfn_bucket_policy) ⇒ AWSCDK::S3::BucketPolicy

Create a mutable BucketPolicy from a CfnBucketPolicy.

Parameters:

Returns:

  • (AWSCDK::S3::BucketPolicy) 


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

def self.from_cfn_bucket_policy(cfn_bucket_policy)
  Jsii::Type.check_type(cfn_bucket_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuQ2ZuQnVja2V0UG9saWN5In0=")), "cfnBucketPolicy")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_s3.BucketPolicy", "fromCfnBucketPolicy", [cfn_bucket_policy])
end

.jsii_overridable_methods ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 's3/bucket_policy.rb', line 43

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :bucket => { kind: :property, name: "bucket", is_optional: false },
    :bucket_policy_ref => { kind: :property, name: "bucketPolicyRef", is_optional: false },
    :document => { kind: :property, name: "document", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


117
118
119
 
# File 's3/bucket_policy.rb', line 117

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

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



178
179
180
181
 
# File 's3/bucket_policy.rb', line 178

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(removal_policy) ⇒ void

This method returns an undefined value.

Sets the removal policy for the BucketPolicy.

Parameters:



187
188
189
190
 
# File 's3/bucket_policy.rb', line 187

def apply_removal_policy(removal_policy)
  Jsii::Type.check_type(removal_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "removalPolicy")
  jsii_call_method("applyRemovalPolicy", [removal_policy])
end

#bucket ⇒ AWSCDK::S3::IBucket

The Bucket this Policy applies to.

Returns:



124
125
126
 
# File 's3/bucket_policy.rb', line 124

def bucket()
  jsii_get_property("bucket")
end

#bucket_policy_ref ⇒ AWSCDK::Interfaces::AWSS3::BucketPolicyReference

A reference to a BucketPolicy resource.

Returns:



131
132
133
 
# File 's3/bucket_policy.rb', line 131

def bucket_policy_ref()
  jsii_get_property("bucketPolicyRef")
end

#document ⇒ AWSCDK::IAM::PolicyDocument

A policy document containing permissions to add to the specified bucket.

For more information, see Access Policy Language Overview in the Amazon Simple Storage Service Developer Guide.

Returns:



141
142
143
 
# File 's3/bucket_policy.rb', line 141

def document()
  jsii_get_property("document")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



89
90
91
 
# File 's3/bucket_policy.rb', line 89

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


193
194
195
 
# File 's3/bucket_policy.rb', line 193

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


207
208
209
210
211
212
 
# File 's3/bucket_policy.rb', line 207

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


222
223
224
225
 
# File 's3/bucket_policy.rb', line 222

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


74
75
76
 
# File 's3/bucket_policy.rb', line 74

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


103
104
105
 
# File 's3/bucket_policy.rb', line 103

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



110
111
112
 
# File 's3/bucket_policy.rb', line 110

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


148
149
150
 
# File 's3/bucket_policy.rb', line 148

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


161
162
163
164
165
166
 
# File 's3/bucket_policy.rb', line 161

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end