@guardian/cdk
    Preparing search index...

    Class GuRepository

    A construct representing an ECR repository in the central artifacts account. This repository is assumed to exist in the central artifacts account and is not created by this construct.

    Use getImage to obtain a ContainerImage for this repository.

    Hierarchy

    • RepositoryBase
      • GuRepository
    Index
    constructor
    node repositoryArn repositoryName
    env physicalName registryUri repositoryRef repositoryUri stack
    _enableCrossEnvironment addToResourcePolicy applyCrossStackReferenceStrength applyRemovalPolicy generatePhysicalName getImage getResourceArnAttribute getResourceNameAttribute grant grantPull grantPullPush grantPush grantRead onCloudTrailEvent onCloudTrailImagePushed onEvent onImageScanCompleted repositoryUriForDigest repositoryUriForTag repositoryUriForTagOrDigest toString with isConstruct isOwnedResource isResource
    node: Node

    The tree node.

    repositoryArn: string

    The ARN of the repository

    repositoryName: string

    The name of the repository

    • get env(): 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 ResourceEnvironment

    • get physicalName(): 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

    • get registryUri(): string

      The URI of this repository's registry:

      ACCOUNT.dkr.ecr.REGION.amazonaws.com

      Returns string

    • get repositoryRef(): RepositoryReference

      A reference to this repository

      Returns RepositoryReference

    • get repositoryUri(): string

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

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

      Returns string

    • get stack(): Stack

      The stack in which this resource is defined.

      Returns Stack

    _enableCrossEnvironment

    • _enableCrossEnvironment(): void
      Internal

      Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

      Returns void

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

      Returns AddToResourcePolicyResult

    • 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

      • strength: ReferenceStrength

        The reference strength to use for this resource.

      Returns void

    • 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

      • policy: RemovalPolicy

      Returns void

    • Returns string

    • Reference an image in this repository.

      Parameters

      • digestOrTag: string

      Returns EcrImage

      a ContainerImage representing the specified tag or digest of this repository.

      ContainerImage.fromEcrRepository

    • 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 arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

      Parameters

      • arnAttr: string

        The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

      • arnComponents: ArnComponents

        The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

      Returns 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 nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

      Parameters

      • nameAttr: string

        The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

      Returns string

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

      Parameters

      • grantee: IGrantable
      • ...actions: string[]

      Returns Grant

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

      Parameters

      • grantee: IGrantable

      Returns Grant

    • Grant the given identity permissions to pull and push images to this repository. [disable-awslint:no-grants]

      Parameters

      • grantee: IGrantable

      Returns Grant

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

      Parameters

      • grantee: IGrantable

      Returns Grant

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

      Parameters

      • grantee: IGrantable

      Returns Grant

    • 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

      • id: string

        The id of the rule

      • Optionaloptions: OnEventOptions

        Options for adding the rule

      Returns 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

      • id: string

        The id of the rule

      • Optionaloptions: OnCloudTrailImagePushedOptions

        Options for adding the rule

      Returns Rule

    • Defines a CloudWatch event rule which triggers for repository events. Use rule.addEventPattern(pattern) to specify a filter.

      Parameters

      • id: string
      • Optionaloptions: OnEventOptions

      Returns Rule

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

      Parameters

      • id: string

        The id of the rule

      • Optionaloptions: OnImageScanCompletedOptions

        Options for adding the rule

      Returns Rule

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

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

      Parameters

      • Optionaldigest: 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[:TAG]

      Parameters

      • Optionaltag: string

        Optional image tag

      Returns string

    • Returns a string representation of this construct.

      Returns string

    • 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: IMixin[]

        The mixins to apply

      Returns IConstruct

      This construct for chaining

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

    • Returns true if the construct was created by CDK, and false otherwise

      Parameters

      • construct: IConstruct

      Returns boolean

    • Check whether the given construct is a Resource

      Parameters

      • construct: IConstruct

      Returns construct is Resource

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods