class RepositoryBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECR.RepositoryBase |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecr#RepositoryBase |
![]() | software.amazon.awscdk.services.ecr.RepositoryBase |
![]() | aws_cdk.aws_ecr.RepositoryBase |
![]() | aws-cdk-lib » aws_ecr » RepositoryBase |
Implements
IConstruct
, IDependable
, IResource
, IRepository
Extends
Resource
Implemented by
Repository
Base class for ECR repository.
Reused between imported repositories and owned repositories.
Initializer
new RepositoryBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
registry | string | The URI of this repository's registry:. |
repository | string | The ARN of the repository. |
repository | string | The name of the repository. |
repository | string | The URI of this repository (represents the latest image):. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
registryUri
Type:
string
The URI of this repository's registry:.
ACCOUNT.dkr.ecr.REGION.amazonaws.com
repositoryArn
Type:
string
The ARN of the repository.
repositoryName
Type:
string
The name of the repository.
repositoryUri
Type:
string
The URI of this repository (represents the latest image):.
ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
add | Add a policy statement to the repository's resource policy. |
apply | Apply the given removal policy to this resource. |
grant(grantee, ...actions) | Grant the given principal identity permissions to perform the actions on this repository. |
grant | Grant the given identity permissions to use the images in this repository. |
grant | Grant the given identity permissions to pull and push images to this repository. |
grant | Grant the given identity permissions to use the images in this repository. |
grant | Grant the given identity permissions to read the images in this repository. |
on | Define a CloudWatch event that triggers when something happens to this repository. |
on | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. |
on | Defines a CloudWatch event rule which triggers for repository events. |
on | Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed. |
repository | Returns the URL of the repository. Can be used in docker push/pull . |
repository | Returns the URL of the repository. Can be used in docker push/pull . |
repository | Returns the URL of the repository. Can be used in docker push/pull . |
to | Returns a string representation of this construct. |
addToResourcePolicy(statement)
public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult
Parameters
- statement
Policy
Statement
Returns
Add a policy statement to the repository's resource policy.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
grant(grantee, ...actions)
public grant(grantee: IGrantable, ...actions: string[]): Grant
Parameters
- grantee
IGrantable
- actions
string
Returns
Grant the given principal identity permissions to perform the actions on this repository.
grantPull(grantee)
public grantPull(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permissions to use the images in this repository.
grantPullPush(grantee)
public grantPullPush(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permissions to pull and push images to this repository.
grantPush(grantee)
public grantPush(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permissions to use the images in this repository.
grantRead(grantee)
public grantRead(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permissions to read the images in this repository.
onCloudTrailEvent(id, options?)
public onCloudTrailEvent(id: string, options?: OnEventOptions): Rule
Parameters
- id
string
— The id of the rule. - options
On
— Options for adding the rule.Event Options
Returns
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.
onCloudTrailImagePushed(id, options?)
public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions): Rule
Parameters
- id
string
— The id of the rule. - options
On
— Options for adding the rule.Cloud Trail Image Pushed Options
Returns
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.
onEvent(id, options?)
public onEvent(id: string, options?: OnEventOptions): Rule
Parameters
- id
string
- options
On
Event Options
Returns
Defines a CloudWatch event rule which triggers for repository events.
Use
rule.addEventPattern(pattern)
to specify a filter.
onImageScanCompleted(id, options?)
public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions): Rule
Parameters
- id
string
— The id of the rule. - options
On
— Options for adding the rule.Image Scan Completed Options
Returns
Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed.
repositoryUriForDigest(digest?)
public repositoryUriForDigest(digest?: string): string
Parameters
- digest
string
— Optional image digest.
Returns
string
Returns the URL of the repository. Can be used in docker push/pull
.
ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
repositoryUriForTag(tag?)
public repositoryUriForTag(tag?: string): string
Parameters
- tag
string
— Optional image tag.
Returns
string
Returns the URL of the repository. Can be used in docker push/pull
.
ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
repositoryUriForTagOrDigest(tagOrDigest?)
public repositoryUriForTagOrDigest(tagOrDigest?: string): string
Parameters
- tagOrDigest
string
— Optional image tag or digest (digests must start withsha256:
).
Returns
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]
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.