Class: AWSCDK::ECR::RepositoryBase

Inherits:
Resource
  • Object
show all
Includes:
IRepository
Defined in:
ecr/repository_base.rb

Overview

Base class for ECR repository.

Reused between imported repositories and owned repositories.

Direct Known Subclasses

Repository

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ RepositoryBase

Returns a new instance of RepositoryBase.

Parameters:



14
15
16
17
18
19
20
 
# File 'ecr/repository_base.rb', line 14

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ResourceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvdXJjZVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'ecr/repository_base.rb', line 22

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 },
    :registry_uri => { kind: :property, name: "registryUri", is_optional: false },
    :repository_arn => { kind: :property, name: "repositoryArn", is_optional: false },
    :repository_name => { kind: :property, name: "repositoryName", is_optional: false },
    :repository_ref => { kind: :property, name: "repositoryRef", is_optional: false },
    :repository_uri => { kind: :property, name: "repositoryUri", 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 },
    :add_to_resource_policy => { kind: :method, name: "addToResourcePolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_pull => { kind: :method, name: "grantPull", is_optional: false },
    :grant_pull_push => { kind: :method, name: "grantPullPush", is_optional: false },
    :grant_push => { kind: :method, name: "grantPush", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :on_cloud_trail_event => { kind: :method, name: "onCloudTrailEvent", is_optional: false },
    :on_cloud_trail_image_pushed => { kind: :method, name: "onCloudTrailImagePushed", is_optional: false },
    :on_event => { kind: :method, name: "onEvent", is_optional: false },
    :on_image_scan_completed => { kind: :method, name: "onImageScanCompleted", is_optional: false },
    :repository_uri_for_digest => { kind: :method, name: "repositoryUriForDigest", is_optional: false },
    :repository_uri_for_tag => { kind: :method, name: "repositoryUriForTag", is_optional: false },
    :repository_uri_for_tag_or_digest => { kind: :method, name: "repositoryUriForTagOrDigest", is_optional: false },
  }
end

Instance Method Details

#add_to_resource_policy(statement) ⇒ AWSCDK::IAM::AddToResourcePolicyResult

Add a policy statement to the repository's resource policy.

Parameters:

Returns:



232
233
234
235
 
# File 'ecr/repository_base.rb', line 232

def add_to_resource_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToResourcePolicy", [statement])
end

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



171
172
173
174
 
# File 'ecr/repository_base.rb', line 171

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(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



188
189
190
191
 
# File 'ecr/repository_base.rb', line 188

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



74
75
76
 
# File 'ecr/repository_base.rb', line 74

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


194
195
196
 
# File 'ecr/repository_base.rb', line 194

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) 


208
209
210
211
212
213
 
# File 'ecr/repository_base.rb', line 208

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) 


223
224
225
226
 
# File 'ecr/repository_base.rb', line 223

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

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grant the given principal identity permissions to perform the actions on this repository [disable-awslint:no-grants].

Parameters:

Returns:



242
243
244
245
246
247
248
 
# File 'ecr/repository_base.rb', line 242

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_pull(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to use the images in this repository [disable-awslint:no-grants].

Parameters:

Returns:



254
255
256
257
 
# File 'ecr/repository_base.rb', line 254

def grant_pull(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPull", [grantee])
end

#grant_pull_push(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to pull and push images to this repository.

[disable-awslint:no-grants]

Parameters:

Returns:



265
266
267
268
 
# File 'ecr/repository_base.rb', line 265

def grant_pull_push(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPullPush", [grantee])
end

#grant_push(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to use the images in this repository [disable-awslint:no-grants].

Parameters:

Returns:



274
275
276
277
 
# File 'ecr/repository_base.rb', line 274

def grant_push(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantPush", [grantee])
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to read the images in this repository [disable-awslint:no-grants].

Parameters:

Returns:



283
284
285
286
 
# File 'ecr/repository_base.rb', line 283

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


59
60
61
 
# File 'ecr/repository_base.rb', line 59

def node()
  jsii_get_property("node")
end

#on_cloud_trail_event(id, options = nil) ⇒ AWSCDK::Events::Rule

Define a CloudWatch event that triggers when something happens to this repository.

Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.

Parameters:

Returns:



296
297
298
299
300
301
 
# File 'ecr/repository_base.rb', line 296

def on_cloud_trail_event(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Events::OnEventOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9uRXZlbnRPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("onCloudTrailEvent", [id, options])
end

#on_cloud_trail_image_pushed(id, options = nil) ⇒ AWSCDK::Events::Rule

Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.

Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.

Parameters:

Returns:



311
312
313
314
315
316
 
# File 'ecr/repository_base.rb', line 311

def on_cloud_trail_image_pushed(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::ECR::OnCloudTrailImagePushedOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNyLk9uQ2xvdWRUcmFpbEltYWdlUHVzaGVkT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("onCloudTrailImagePushed", [id, options])
end

#on_event(id, options = nil) ⇒ AWSCDK::Events::Rule

Defines a CloudWatch event rule which triggers for repository events.

Use rule.addEventPattern(pattern) to specify a filter.

Parameters:

Returns:



326
327
328
329
330
331
 
# File 'ecr/repository_base.rb', line 326

def on_event(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Events::OnEventOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9uRXZlbnRPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("onEvent", [id, options])
end

#on_image_scan_completed(id, options = nil) ⇒ AWSCDK::Events::Rule

Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed.

Parameters:

Returns:



338
339
340
341
342
343
 
# File 'ecr/repository_base.rb', line 338

def on_image_scan_completed(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::ECR::OnImageScanCompletedOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNyLk9uSW1hZ2VTY2FuQ29tcGxldGVkT3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("onImageScanCompleted", [id, options])
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) 


88
89
90
 
# File 'ecr/repository_base.rb', line 88

def physical_name()
  jsii_get_property("physicalName")
end

#registry_uri ⇒ String

The URI of this repository's registry:.

ACCOUNT.dkr.ecr.REGION.amazonaws.com

Returns:

  • (String) 


104
105
106
 
# File 'ecr/repository_base.rb', line 104

def registry_uri()
  jsii_get_property("registryUri")
end

#repository_arn ⇒ String

The ARN of the repository.

Returns:

  • (String) 


111
112
113
 
# File 'ecr/repository_base.rb', line 111

def repository_arn()
  jsii_get_property("repositoryArn")
end

#repository_name ⇒ String

The name of the repository.

Returns:

  • (String) 


118
119
120
 
# File 'ecr/repository_base.rb', line 118

def repository_name()
  jsii_get_property("repositoryName")
end

#repository_ref ⇒ AWSCDK::Interfaces::AWSECR::RepositoryReference

A reference to this repository.

Returns:



125
126
127
 
# File 'ecr/repository_base.rb', line 125

def repository_ref()
  jsii_get_property("repositoryRef")
end

#repository_uri ⇒ String

The URI of this repository (represents the latest image):.

ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY

Returns:

  • (String) 


134
135
136
 
# File 'ecr/repository_base.rb', line 134

def repository_uri()
  jsii_get_property("repositoryUri")
end

#repository_uri_for_digest(digest = nil) ⇒ String

Returns the URL of the repository. Can be used in docker push/pull.

ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]

Parameters:

  • digest (String, nil) (defaults to: nil) —

    Optional image digest.

Returns:

  • (String) 


351
352
353
354
 
# File 'ecr/repository_base.rb', line 351

def repository_uri_for_digest(digest = nil)
  Jsii::Type.check_type(digest, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "digest") unless digest.nil?
  jsii_call_method("repositoryUriForDigest", [digest])
end

#repository_uri_for_tag(tag = nil) ⇒ String

Returns the URL of the repository. Can be used in docker push/pull.

ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]

Parameters:

  • tag (String, nil) (defaults to: nil) —

    Optional image tag.

Returns:

  • (String) 


362
363
364
365
 
# File 'ecr/repository_base.rb', line 362

def repository_uri_for_tag(tag = nil)
  Jsii::Type.check_type(tag, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tag") unless tag.nil?
  jsii_call_method("repositoryUriForTag", [tag])
end

#repository_uri_for_tag_or_digest(tag_or_digest = nil) ⇒ String

Returns the URL of the repository. Can be used in docker push/pull.

ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG] ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]

Parameters:

  • tag_or_digest (String, nil) (defaults to: nil) —

    Optional image tag or digest (digests must start with sha256:).

Returns:

  • (String) 


374
375
376
377
 
# File 'ecr/repository_base.rb', line 374

def repository_uri_for_tag_or_digest(tag_or_digest = nil)
  Jsii::Type.check_type(tag_or_digest, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tagOrDigest") unless tag_or_digest.nil?
  jsii_call_method("repositoryUriForTagOrDigest", [tag_or_digest])
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



95
96
97
 
# File 'ecr/repository_base.rb', line 95

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


141
142
143
 
# File 'ecr/repository_base.rb', line 141

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) 


154
155
156
157
158
159
 
# File 'ecr/repository_base.rb', line 154

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