// Jest Snapshot v1, https://goo.gl/fbAQLP exports[`csharp snapshot 1`] = ` { "displayName": "IRepository", "docs": { "summary": "Represents an ECR repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "implementations": [ { "displayName": "Repository", "fqn": "Amazon.CDK.AWS.ECR.Repository", "id": "@aws-cdk/aws-ecr.Repository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "RepositoryBase", "fqn": "Amazon.CDK.AWS.ECR.RepositoryBase", "id": "@aws-cdk/aws-ecr.RepositoryBase", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "IRepository", "fqn": "Amazon.CDK.AWS.ECR.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, ], "instanceMethods": [ { "displayName": "AddToResourcePolicy", "docs": { "summary": "Add a policy statement to the repository's resource policy.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.AddToResourcePolicy", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", "parameters": [ { "default": undefined, "displayName": "Statement", "docs": {}, "fqn": "Amazon.CDK.AWS.ECR.IRepository.AddToResourcePolicy.parameter.Statement", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "PolicyStatement", "fqn": "Amazon.CDK.AWS.IAM.PolicyStatement", "id": "@aws-cdk/aws-iam.PolicyStatement", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "private AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement Statement)", }, { "displayName": "Grant", "docs": { "summary": "Grant the given principal identity permissions to perform the actions on this repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.Grant", "id": "@aws-cdk/aws-ecr.IRepository.grant", "parameters": [ { "default": undefined, "displayName": "Grantee", "docs": {}, "fqn": "Amazon.CDK.AWS.ECR.IRepository.Grant.parameter.Grantee", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "Amazon.CDK.AWS.IAM.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, { "default": undefined, "displayName": "Actions", "docs": {}, "fqn": "Amazon.CDK.AWS.ECR.IRepository.Grant.parameter.Actions", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", "optional": undefined, "type": { "formattingPattern": "string", }, }, ], "usage": "private Grant Grant(IGrantable Grantee, string Actions)", }, { "displayName": "GrantPull", "docs": { "summary": "Grant the given identity permissions to pull images in this repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPull", "id": "@aws-cdk/aws-ecr.IRepository.grantPull", "parameters": [ { "default": undefined, "displayName": "Grantee", "docs": {}, "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPull.parameter.Grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "Amazon.CDK.AWS.IAM.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "private Grant GrantPull(IGrantable Grantee)", }, { "displayName": "GrantPullPush", "docs": { "summary": "Grant the given identity permissions to pull and push images to this repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPullPush", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", "parameters": [ { "default": undefined, "displayName": "Grantee", "docs": {}, "fqn": "Amazon.CDK.AWS.ECR.IRepository.GrantPullPush.parameter.Grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "Amazon.CDK.AWS.IAM.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "private Grant GrantPullPush(IGrantable Grantee)", }, { "displayName": "OnCloudTrailEvent", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Define a CloudWatch event that triggers when something happens to this repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailEvent", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", "parameters": [ { "default": undefined, "displayName": "Id", "docs": { "summary": "The id of the rule.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailEvent.parameter.Id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "Options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailEvent.parameter.Options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "Amazon.CDK.AWS.Events.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "private Rule OnCloudTrailEvent(string Id, OnEventOptions Options = null)", }, { "displayName": "OnCloudTrailImagePushed", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailImagePushed", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", "parameters": [ { "default": undefined, "displayName": "Id", "docs": { "summary": "The id of the rule.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailImagePushed.parameter.Id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "Options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnCloudTrailImagePushed.parameter.Options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnCloudTrailImagePushedOptions", "fqn": "Amazon.CDK.AWS.ECR.OnCloudTrailImagePushedOptions", "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "private Rule OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null)", }, { "displayName": "OnEvent", "docs": { "remarks": "Use \`rule.addEventPattern(pattern)\` to specify a filter.", "summary": "Defines a CloudWatch event rule which triggers for repository events.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnEvent", "id": "@aws-cdk/aws-ecr.IRepository.onEvent", "parameters": [ { "default": undefined, "displayName": "Id", "docs": {}, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnEvent.parameter.Id", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "Options", "docs": {}, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnEvent.parameter.Options", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "Amazon.CDK.AWS.Events.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "private Rule OnEvent(string Id, OnEventOptions Options = null)", }, { "displayName": "OnImageScanCompleted", "docs": { "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnImageScanCompleted", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", "parameters": [ { "default": undefined, "displayName": "Id", "docs": { "summary": "The id of the rule.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnImageScanCompleted.parameter.Id", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "Options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.OnImageScanCompleted.parameter.Options", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnImageScanCompletedOptions", "fqn": "Amazon.CDK.AWS.ECR.OnImageScanCompletedOptions", "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "private Rule OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null)", }, { "displayName": "RepositoryUriForDigest", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForDigest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", "parameters": [ { "default": undefined, "displayName": "Digest", "docs": { "summary": "Image digest to use (tools usually default to the image with the "latest" tag if omitted).", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForDigest.parameter.Digest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", "optional": true, "type": { "formattingPattern": "string", }, }, ], "usage": "private string RepositoryUriForDigest(string Digest = null)", }, { "displayName": "RepositoryUriForTag", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForTag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", "parameters": [ { "default": undefined, "displayName": "Tag", "docs": { "summary": "Image tag to use (tools usually default to "latest" if omitted).", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.RepositoryUriForTag.parameter.Tag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", "optional": true, "type": { "formattingPattern": "string", }, }, ], "usage": "private string RepositoryUriForTag(string Tag = null)", }, ], "interfaces": [ { "displayName": "IResource", "fqn": "Amazon.CDK.IResource", "id": "@aws-cdk/core.IResource", "packageName": "@aws-cdk/core", "packageVersion": "1.106.0", }, ], "properties": [ { "default": undefined, "displayName": "Node", "docs": { "summary": "The construct tree node for this construct.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.Node", "id": "@aws-cdk/aws-ecr.IRepository.property.node", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ConstructNode", "fqn": "Amazon.CDK.ConstructNode", "id": "@aws-cdk/core.ConstructNode", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public ConstructNode Node { get; }", }, { "default": undefined, "displayName": "Env", "docs": { "remarks": "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.", "summary": "The environment this resource belongs to.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.Env", "id": "@aws-cdk/aws-ecr.IRepository.property.env", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ResourceEnvironment", "fqn": "Amazon.CDK.ResourceEnvironment", "id": "@aws-cdk/core.ResourceEnvironment", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public ResourceEnvironment Env { get; }", }, { "default": undefined, "displayName": "Stack", "docs": { "summary": "The stack in which this resource is defined.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.Stack", "id": "@aws-cdk/aws-ecr.IRepository.property.stack", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "Stack", "fqn": "Amazon.CDK.Stack", "id": "@aws-cdk/core.Stack", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public Stack Stack { get; }", }, { "default": undefined, "displayName": "RepositoryArn", "docs": { "summary": "The ARN of the repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.RepositoryArn", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", "optional": undefined, "type": { "formattingPattern": "string", }, "usage": "public string RepositoryArn { get; }", }, { "default": undefined, "displayName": "RepositoryName", "docs": { "summary": "The name of the repository.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.RepositoryName", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", "optional": undefined, "type": { "formattingPattern": "string", }, "usage": "public string RepositoryName { get; }", }, { "default": undefined, "displayName": "RepositoryUri", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", "summary": "The URI of this repository (represents the latest image):.", }, "fqn": "Amazon.CDK.AWS.ECR.IRepository.property.RepositoryUri", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", "optional": undefined, "type": { "formattingPattern": "string", }, "usage": "public string RepositoryUri { get; }", }, ], } `; exports[`csharp snapshot 2`] = ` " IRepository <a name="IRepository" id="@aws-cdk/aws-ecr.IRepository"></a> - *Extends:* Amazon.CDK.IResource - *Implemented By:* <a href="#@aws-cdk/aws-ecr.Repository">Repository</a>, <a href="#@aws-cdk/aws-ecr.RepositoryBase">RepositoryBase</a>, <a href="#@aws-cdk/aws-ecr.IRepository">IRepository</a> Represents an ECR repository. # Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.addToResourcePolicy">AddToResourcePolicy</a></code> | Add a policy statement to the repository's resource policy. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grant">Grant</a></code> | Grant the given principal identity permissions to perform the actions on this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPull">GrantPull</a></code> | Grant the given identity permissions to pull images in this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPullPush">GrantPullPush</a></code> | Grant the given identity permissions to pull and push images to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent">OnCloudTrailEvent</a></code> | Define a CloudWatch event that triggers when something happens to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed">OnCloudTrailImagePushed</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onEvent">OnEvent</a></code> | Defines a CloudWatch event rule which triggers for repository events. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onImageScanCompleted">OnImageScanCompleted</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest">RepositoryUriForDigest</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForTag">RepositoryUriForTag</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- ## \`AddToResourcePolicy\` <a name="AddToResourcePolicy" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy"></a> \`\`\`csharp private AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement Statement) \`\`\` Add a policy statement to the repository's resource policy. ### \`Statement\`<sup>Required</sup> <a name="Statement" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement"></a> - *Type:* Amazon.CDK.AWS.IAM.PolicyStatement --- ## \`Grant\` <a name="Grant" id="@aws-cdk/aws-ecr.IRepository.grant"></a> \`\`\`csharp private Grant Grant(IGrantable Grantee, string Actions) \`\`\` Grant the given principal identity permissions to perform the actions on this repository. ### \`Grantee\`<sup>Required</sup> <a name="Grantee" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee"></a> - *Type:* Amazon.CDK.AWS.IAM.IGrantable --- ### \`Actions\`<sup>Required</sup> <a name="Actions" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.actions"></a> - *Type:* string --- ## \`GrantPull\` <a name="GrantPull" id="@aws-cdk/aws-ecr.IRepository.grantPull"></a> \`\`\`csharp private Grant GrantPull(IGrantable Grantee) \`\`\` Grant the given identity permissions to pull images in this repository. ### \`Grantee\`<sup>Required</sup> <a name="Grantee" id="@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee"></a> - *Type:* Amazon.CDK.AWS.IAM.IGrantable --- ## \`GrantPullPush\` <a name="GrantPullPush" id="@aws-cdk/aws-ecr.IRepository.grantPullPush"></a> \`\`\`csharp private Grant GrantPullPush(IGrantable Grantee) \`\`\` Grant the given identity permissions to pull and push images to this repository. ### \`Grantee\`<sup>Required</sup> <a name="Grantee" id="@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee"></a> - *Type:* Amazon.CDK.AWS.IAM.IGrantable --- ## \`OnCloudTrailEvent\` <a name="OnCloudTrailEvent" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent"></a> \`\`\`csharp private Rule OnCloudTrailEvent(string Id, OnEventOptions Options = null) \`\`\` 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. ### \`Id\`<sup>Required</sup> <a name="Id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id"></a> - *Type:* string The id of the rule. --- ### \`Options\`<sup>Optional</sup> <a name="Options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options"></a> - *Type:* Amazon.CDK.AWS.Events.OnEventOptions Options for adding the rule. --- ## \`OnCloudTrailImagePushed\` <a name="OnCloudTrailImagePushed" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed"></a> \`\`\`csharp private Rule OnCloudTrailImagePushed(string Id, OnCloudTrailImagePushedOptions Options = null) \`\`\` 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. ### \`Id\`<sup>Required</sup> <a name="Id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id"></a> - *Type:* string The id of the rule. --- ### \`Options\`<sup>Optional</sup> <a name="Options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions">OnCloudTrailImagePushedOptions</a> Options for adding the rule. --- ## \`OnEvent\` <a name="OnEvent" id="@aws-cdk/aws-ecr.IRepository.onEvent"></a> \`\`\`csharp private Rule OnEvent(string Id, OnEventOptions Options = null) \`\`\` Defines a CloudWatch event rule which triggers for repository events. Use \`rule.addEventPattern(pattern)\` to specify a filter. ### \`Id\`<sup>Required</sup> <a name="Id" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id"></a> - *Type:* string --- ### \`Options\`<sup>Optional</sup> <a name="Options" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options"></a> - *Type:* Amazon.CDK.AWS.Events.OnEventOptions --- ## \`OnImageScanCompleted\` <a name="OnImageScanCompleted" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted"></a> \`\`\`csharp private Rule OnImageScanCompleted(string Id, OnImageScanCompletedOptions Options = null) \`\`\` Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. ### \`Id\`<sup>Required</sup> <a name="Id" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id"></a> - *Type:* string The id of the rule. --- ### \`Options\`<sup>Optional</sup> <a name="Options" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnImageScanCompletedOptions">OnImageScanCompletedOptions</a> Options for adding the rule. --- ## \`RepositoryUriForDigest\` <a name="RepositoryUriForDigest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest"></a> \`\`\`csharp private string RepositoryUriForDigest(string Digest = null) \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST] ### \`Digest\`<sup>Optional</sup> <a name="Digest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest"></a> - *Type:* string Image digest to use (tools usually default to the image with the "latest" tag if omitted). --- ## \`RepositoryUriForTag\` <a name="RepositoryUriForTag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag"></a> \`\`\`csharp private string RepositoryUriForTag(string Tag = null) \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG] ### \`Tag\`<sup>Optional</sup> <a name="Tag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag"></a> - *Type:* string Image tag to use (tools usually default to "latest" if omitted). --- # Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.node">Node</a></code> | <code>Amazon.CDK.ConstructNode</code> | The construct tree node for this construct. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.env">Env</a></code> | <code>Amazon.CDK.ResourceEnvironment</code> | The environment this resource belongs to. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.stack">Stack</a></code> | <code>Amazon.CDK.Stack</code> | The stack in which this resource is defined. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryArn">RepositoryArn</a></code> | <code>string</code> | The ARN of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryName">RepositoryName</a></code> | <code>string</code> | The name of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryUri">RepositoryUri</a></code> | <code>string</code> | The URI of this repository (represents the latest image):. | --- ## \`Node\`<sup>Required</sup> <a name="Node" id="@aws-cdk/aws-ecr.IRepository.property.node"></a> \`\`\`csharp public ConstructNode Node { get; } \`\`\` - *Type:* Amazon.CDK.ConstructNode The construct tree node for this construct. --- ## \`Env\`<sup>Required</sup> <a name="Env" id="@aws-cdk/aws-ecr.IRepository.property.env"></a> \`\`\`csharp public ResourceEnvironment Env { get; } \`\`\` - *Type:* Amazon.CDK.ResourceEnvironment 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. --- ## \`Stack\`<sup>Required</sup> <a name="Stack" id="@aws-cdk/aws-ecr.IRepository.property.stack"></a> \`\`\`csharp public Stack Stack { get; } \`\`\` - *Type:* Amazon.CDK.Stack The stack in which this resource is defined. --- ## \`RepositoryArn\`<sup>Required</sup> <a name="RepositoryArn" id="@aws-cdk/aws-ecr.IRepository.property.repositoryArn"></a> \`\`\`csharp public string RepositoryArn { get; } \`\`\` - *Type:* string The ARN of the repository. --- ## \`RepositoryName\`<sup>Required</sup> <a name="RepositoryName" id="@aws-cdk/aws-ecr.IRepository.property.repositoryName"></a> \`\`\`csharp public string RepositoryName { get; } \`\`\` - *Type:* string The name of the repository. --- ## \`RepositoryUri\`<sup>Required</sup> <a name="RepositoryUri" id="@aws-cdk/aws-ecr.IRepository.property.repositoryUri"></a> \`\`\`csharp public string RepositoryUri { get; } \`\`\` - *Type:* string The URI of this repository (represents the latest image):. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- " `; exports[`go snapshot 1`] = ` { "displayName": "IRepository", "docs": { "summary": "Represents an ECR repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "implementations": [ { "displayName": "Repository", "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.Repository", "id": "@aws-cdk/aws-ecr.Repository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "RepositoryBase", "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.RepositoryBase", "id": "@aws-cdk/aws-ecr.RepositoryBase", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "IRepository", "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, ], "instanceMethods": [ { "displayName": "AddToResourcePolicy", "docs": { "summary": "Add a policy statement to the repository's resource policy.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.AddToResourcePolicy", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", "parameters": [ { "default": undefined, "displayName": "statement", "docs": {}, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.AddToResourcePolicy.parameter.statement", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "PolicyStatement", "fqn": "github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.PolicyStatement", "id": "@aws-cdk/aws-iam.PolicyStatement", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "func AddToResourcePolicy(statement PolicyStatement) AddToResourcePolicyResult", }, { "displayName": "Grant", "docs": { "summary": "Grant the given principal identity permissions to perform the actions on this repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.Grant", "id": "@aws-cdk/aws-ecr.IRepository.grant", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.Grant.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, { "default": undefined, "displayName": "actions", "docs": {}, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.Grant.parameter.actions", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", "optional": undefined, "type": { "formattingPattern": "*string", }, }, ], "usage": "func Grant(grantee IGrantable, actions *string) Grant", }, { "displayName": "GrantPull", "docs": { "summary": "Grant the given identity permissions to pull images in this repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.GrantPull", "id": "@aws-cdk/aws-ecr.IRepository.grantPull", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.GrantPull.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "func GrantPull(grantee IGrantable) Grant", }, { "displayName": "GrantPullPush", "docs": { "summary": "Grant the given identity permissions to pull and push images to this repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.GrantPullPush", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.GrantPullPush.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "func GrantPullPush(grantee IGrantable) Grant", }, { "displayName": "OnCloudTrailEvent", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Define a CloudWatch event that triggers when something happens to this repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnCloudTrailEvent", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnCloudTrailEvent.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "*string", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnCloudTrailEvent.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "github.com/aws/aws-cdk-go/awscdkawsevents/awscdkawsevents.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "func OnCloudTrailEvent(id *string, options OnEventOptions) Rule", }, { "displayName": "OnCloudTrailImagePushed", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnCloudTrailImagePushed", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnCloudTrailImagePushed.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", "optional": undefined, "type": { "formattingPattern": "*string", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnCloudTrailImagePushed.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnCloudTrailImagePushedOptions", "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.OnCloudTrailImagePushedOptions", "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "func OnCloudTrailImagePushed(id *string, options OnCloudTrailImagePushedOptions) Rule", }, { "displayName": "OnEvent", "docs": { "remarks": "Use \`rule.addEventPattern(pattern)\` to specify a filter.", "summary": "Defines a CloudWatch event rule which triggers for repository events.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnEvent", "id": "@aws-cdk/aws-ecr.IRepository.onEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": {}, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnEvent.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "*string", }, }, { "default": undefined, "displayName": "options", "docs": {}, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnEvent.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "github.com/aws/aws-cdk-go/awscdkawsevents/awscdkawsevents.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "func OnEvent(id *string, options OnEventOptions) Rule", }, { "displayName": "OnImageScanCompleted", "docs": { "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnImageScanCompleted", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnImageScanCompleted.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", "optional": undefined, "type": { "formattingPattern": "*string", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.OnImageScanCompleted.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnImageScanCompletedOptions", "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.OnImageScanCompletedOptions", "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "func OnImageScanCompleted(id *string, options OnImageScanCompletedOptions) Rule", }, { "displayName": "RepositoryUriForDigest", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.RepositoryUriForDigest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", "parameters": [ { "default": undefined, "displayName": "digest", "docs": { "summary": "Image digest to use (tools usually default to the image with the "latest" tag if omitted).", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.RepositoryUriForDigest.parameter.digest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", "optional": true, "type": { "formattingPattern": "*string", }, }, ], "usage": "func RepositoryUriForDigest(digest *string) *string", }, { "displayName": "RepositoryUriForTag", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.RepositoryUriForTag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", "parameters": [ { "default": undefined, "displayName": "tag", "docs": { "summary": "Image tag to use (tools usually default to "latest" if omitted).", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.RepositoryUriForTag.parameter.tag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", "optional": true, "type": { "formattingPattern": "*string", }, }, ], "usage": "func RepositoryUriForTag(tag *string) *string", }, ], "interfaces": [ { "displayName": "IResource", "fqn": "github.com/aws/aws-cdk-go/awscdk/awscdkcore.IResource", "id": "@aws-cdk/core.IResource", "packageName": "@aws-cdk/core", "packageVersion": "1.106.0", }, ], "properties": [ { "default": undefined, "displayName": "Node", "docs": { "summary": "The construct tree node for this construct.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.property.Node", "id": "@aws-cdk/aws-ecr.IRepository.property.node", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ConstructNode", "fqn": "github.com/aws/aws-cdk-go/awscdk/awscdkcore.ConstructNode", "id": "@aws-cdk/core.ConstructNode", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "func Node() ConstructNode", }, { "default": undefined, "displayName": "Env", "docs": { "remarks": "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.", "summary": "The environment this resource belongs to.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.property.Env", "id": "@aws-cdk/aws-ecr.IRepository.property.env", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ResourceEnvironment", "fqn": "github.com/aws/aws-cdk-go/awscdk/awscdkcore.ResourceEnvironment", "id": "@aws-cdk/core.ResourceEnvironment", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "func Env() ResourceEnvironment", }, { "default": undefined, "displayName": "Stack", "docs": { "summary": "The stack in which this resource is defined.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.property.Stack", "id": "@aws-cdk/aws-ecr.IRepository.property.stack", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "Stack", "fqn": "github.com/aws/aws-cdk-go/awscdk/awscdkcore.Stack", "id": "@aws-cdk/core.Stack", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "func Stack() Stack", }, { "default": undefined, "displayName": "RepositoryArn", "docs": { "summary": "The ARN of the repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.property.RepositoryArn", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", "optional": undefined, "type": { "formattingPattern": "*string", }, "usage": "func RepositoryArn() *string", }, { "default": undefined, "displayName": "RepositoryName", "docs": { "summary": "The name of the repository.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.property.RepositoryName", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", "optional": undefined, "type": { "formattingPattern": "*string", }, "usage": "func RepositoryName() *string", }, { "default": undefined, "displayName": "RepositoryUri", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", "summary": "The URI of this repository (represents the latest image):.", }, "fqn": "github.com/aws/aws-cdk-go/awscdkawsecr.IRepository.property.RepositoryUri", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", "optional": undefined, "type": { "formattingPattern": "*string", }, "usage": "func RepositoryUri() *string", }, ], } `; exports[`go snapshot 2`] = ` " IRepository <a name="IRepository" id="@aws-cdk/aws-ecr.IRepository"></a> - *Extends:* github.com/aws/aws-cdk-go/awscdk/awscdkcore.IResource - *Implemented By:* <a href="#@aws-cdk/aws-ecr.Repository">Repository</a>, <a href="#@aws-cdk/aws-ecr.RepositoryBase">RepositoryBase</a>, <a href="#@aws-cdk/aws-ecr.IRepository">IRepository</a> Represents an ECR repository. # Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.addToResourcePolicy">AddToResourcePolicy</a></code> | Add a policy statement to the repository's resource policy. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grant">Grant</a></code> | Grant the given principal identity permissions to perform the actions on this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPull">GrantPull</a></code> | Grant the given identity permissions to pull images in this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPullPush">GrantPullPush</a></code> | Grant the given identity permissions to pull and push images to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent">OnCloudTrailEvent</a></code> | Define a CloudWatch event that triggers when something happens to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed">OnCloudTrailImagePushed</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onEvent">OnEvent</a></code> | Defines a CloudWatch event rule which triggers for repository events. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onImageScanCompleted">OnImageScanCompleted</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest">RepositoryUriForDigest</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForTag">RepositoryUriForTag</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- ## \`AddToResourcePolicy\` <a name="AddToResourcePolicy" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy"></a> \`\`\`go func AddToResourcePolicy(statement PolicyStatement) AddToResourcePolicyResult \`\`\` Add a policy statement to the repository's resource policy. ### \`statement\`<sup>Required</sup> <a name="statement" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement"></a> - *Type:* github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.PolicyStatement --- ## \`Grant\` <a name="Grant" id="@aws-cdk/aws-ecr.IRepository.grant"></a> \`\`\`go func Grant(grantee IGrantable, actions *string) Grant \`\`\` Grant the given principal identity permissions to perform the actions on this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee"></a> - *Type:* github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.IGrantable --- ### \`actions\`<sup>Required</sup> <a name="actions" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.actions"></a> - *Type:* *string --- ## \`GrantPull\` <a name="GrantPull" id="@aws-cdk/aws-ecr.IRepository.grantPull"></a> \`\`\`go func GrantPull(grantee IGrantable) Grant \`\`\` Grant the given identity permissions to pull images in this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee"></a> - *Type:* github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.IGrantable --- ## \`GrantPullPush\` <a name="GrantPullPush" id="@aws-cdk/aws-ecr.IRepository.grantPullPush"></a> \`\`\`go func GrantPullPush(grantee IGrantable) Grant \`\`\` Grant the given identity permissions to pull and push images to this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee"></a> - *Type:* github.com/aws/aws-cdk-go/awscdk/awsiam/awscdkawsiam.IGrantable --- ## \`OnCloudTrailEvent\` <a name="OnCloudTrailEvent" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent"></a> \`\`\`go func OnCloudTrailEvent(id *string, options OnEventOptions) 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id"></a> - *Type:* *string The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options"></a> - *Type:* github.com/aws/aws-cdk-go/awscdkawsevents/awscdkawsevents.OnEventOptions Options for adding the rule. --- ## \`OnCloudTrailImagePushed\` <a name="OnCloudTrailImagePushed" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed"></a> \`\`\`go func OnCloudTrailImagePushed(id *string, options OnCloudTrailImagePushedOptions) 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id"></a> - *Type:* *string The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions">OnCloudTrailImagePushedOptions</a> Options for adding the rule. --- ## \`OnEvent\` <a name="OnEvent" id="@aws-cdk/aws-ecr.IRepository.onEvent"></a> \`\`\`go func OnEvent(id *string, options OnEventOptions) Rule \`\`\` Defines a CloudWatch event rule which triggers for repository events. Use \`rule.addEventPattern(pattern)\` to specify a filter. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id"></a> - *Type:* *string --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options"></a> - *Type:* github.com/aws/aws-cdk-go/awscdkawsevents/awscdkawsevents.OnEventOptions --- ## \`OnImageScanCompleted\` <a name="OnImageScanCompleted" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted"></a> \`\`\`go func OnImageScanCompleted(id *string, options OnImageScanCompletedOptions) Rule \`\`\` Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id"></a> - *Type:* *string The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnImageScanCompletedOptions">OnImageScanCompletedOptions</a> Options for adding the rule. --- ## \`RepositoryUriForDigest\` <a name="RepositoryUriForDigest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest"></a> \`\`\`go func RepositoryUriForDigest(digest *string) *string \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST] ### \`digest\`<sup>Optional</sup> <a name="digest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest"></a> - *Type:* *string Image digest to use (tools usually default to the image with the "latest" tag if omitted). --- ## \`RepositoryUriForTag\` <a name="RepositoryUriForTag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag"></a> \`\`\`go func RepositoryUriForTag(tag *string) *string \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG] ### \`tag\`<sup>Optional</sup> <a name="tag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag"></a> - *Type:* *string Image tag to use (tools usually default to "latest" if omitted). --- # Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.node">Node</a></code> | <code>github.com/aws/aws-cdk-go/awscdk/awscdkcore.ConstructNode</code> | The construct tree node for this construct. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.env">Env</a></code> | <code>github.com/aws/aws-cdk-go/awscdk/awscdkcore.ResourceEnvironment</code> | The environment this resource belongs to. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.stack">Stack</a></code> | <code>github.com/aws/aws-cdk-go/awscdk/awscdkcore.Stack</code> | The stack in which this resource is defined. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryArn">RepositoryArn</a></code> | <code>*string</code> | The ARN of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryName">RepositoryName</a></code> | <code>*string</code> | The name of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryUri">RepositoryUri</a></code> | <code>*string</code> | The URI of this repository (represents the latest image):. | --- ## \`Node\`<sup>Required</sup> <a name="Node" id="@aws-cdk/aws-ecr.IRepository.property.node"></a> \`\`\`go func Node() ConstructNode \`\`\` - *Type:* github.com/aws/aws-cdk-go/awscdk/awscdkcore.ConstructNode The construct tree node for this construct. --- ## \`Env\`<sup>Required</sup> <a name="Env" id="@aws-cdk/aws-ecr.IRepository.property.env"></a> \`\`\`go func Env() ResourceEnvironment \`\`\` - *Type:* github.com/aws/aws-cdk-go/awscdk/awscdkcore.ResourceEnvironment 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. --- ## \`Stack\`<sup>Required</sup> <a name="Stack" id="@aws-cdk/aws-ecr.IRepository.property.stack"></a> \`\`\`go func Stack() Stack \`\`\` - *Type:* github.com/aws/aws-cdk-go/awscdk/awscdkcore.Stack The stack in which this resource is defined. --- ## \`RepositoryArn\`<sup>Required</sup> <a name="RepositoryArn" id="@aws-cdk/aws-ecr.IRepository.property.repositoryArn"></a> \`\`\`go func RepositoryArn() *string \`\`\` - *Type:* *string The ARN of the repository. --- ## \`RepositoryName\`<sup>Required</sup> <a name="RepositoryName" id="@aws-cdk/aws-ecr.IRepository.property.repositoryName"></a> \`\`\`go func RepositoryName() *string \`\`\` - *Type:* *string The name of the repository. --- ## \`RepositoryUri\`<sup>Required</sup> <a name="RepositoryUri" id="@aws-cdk/aws-ecr.IRepository.property.repositoryUri"></a> \`\`\`go func RepositoryUri() *string \`\`\` - *Type:* *string The URI of this repository (represents the latest image):. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- " `; exports[`java snapshot 1`] = ` { "displayName": "IRepository", "docs": { "summary": "Represents an ECR repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "implementations": [ { "displayName": "Repository", "fqn": "software.amazon.awscdk.services.ecr.Repository", "id": "@aws-cdk/aws-ecr.Repository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "RepositoryBase", "fqn": "software.amazon.awscdk.services.ecr.RepositoryBase", "id": "@aws-cdk/aws-ecr.RepositoryBase", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "IRepository", "fqn": "software.amazon.awscdk.services.ecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, ], "instanceMethods": [ { "displayName": "addToResourcePolicy", "docs": { "summary": "Add a policy statement to the repository's resource policy.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.addToResourcePolicy", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", "parameters": [ { "default": undefined, "displayName": "statement", "docs": {}, "fqn": "software.amazon.awscdk.services.ecr.IRepository.addToResourcePolicy.parameter.statement", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "PolicyStatement", "fqn": "software.amazon.awscdk.services.iam.PolicyStatement", "id": "@aws-cdk/aws-iam.PolicyStatement", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)", }, { "displayName": "grant", "docs": { "summary": "Grant the given principal identity permissions to perform the actions on this repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.grant", "id": "@aws-cdk/aws-ecr.IRepository.grant", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "software.amazon.awscdk.services.ecr.IRepository.grant.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "software.amazon.awscdk.services.iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, { "default": undefined, "displayName": "actions", "docs": {}, "fqn": "software.amazon.awscdk.services.ecr.IRepository.grant.parameter.actions", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, }, ], "usage": "public Grant grant(IGrantable grantee, java.lang.String actions)", }, { "displayName": "grantPull", "docs": { "summary": "Grant the given identity permissions to pull images in this repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPull", "id": "@aws-cdk/aws-ecr.IRepository.grantPull", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPull.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "software.amazon.awscdk.services.iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public Grant grantPull(IGrantable grantee)", }, { "displayName": "grantPullPush", "docs": { "summary": "Grant the given identity permissions to pull and push images to this repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPullPush", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "software.amazon.awscdk.services.ecr.IRepository.grantPullPush.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "software.amazon.awscdk.services.iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public Grant grantPullPush(IGrantable grantee)", }, { "displayName": "onCloudTrailEvent", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Define a CloudWatch event that triggers when something happens to this repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailEvent", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailEvent.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailEvent.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "software.amazon.awscdk.services.events.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public Rule onCloudTrailEvent(java.lang.String id) public Rule onCloudTrailEvent(java.lang.String id, OnEventOptions options)", }, { "displayName": "onCloudTrailImagePushed", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailImagePushed", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailImagePushed.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onCloudTrailImagePushed.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnCloudTrailImagePushedOptions", "fqn": "software.amazon.awscdk.services.ecr.OnCloudTrailImagePushedOptions", "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public Rule onCloudTrailImagePushed(java.lang.String id) public Rule onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options)", }, { "displayName": "onEvent", "docs": { "remarks": "Use \`rule.addEventPattern(pattern)\` to specify a filter.", "summary": "Defines a CloudWatch event rule which triggers for repository events.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onEvent", "id": "@aws-cdk/aws-ecr.IRepository.onEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": {}, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onEvent.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, }, { "default": undefined, "displayName": "options", "docs": {}, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onEvent.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "software.amazon.awscdk.services.events.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public Rule onEvent(java.lang.String id) public Rule onEvent(java.lang.String id, OnEventOptions options)", }, { "displayName": "onImageScanCompleted", "docs": { "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onImageScanCompleted", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onImageScanCompleted.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.onImageScanCompleted.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnImageScanCompletedOptions", "fqn": "software.amazon.awscdk.services.ecr.OnImageScanCompletedOptions", "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public Rule onImageScanCompleted(java.lang.String id) public Rule onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options)", }, { "displayName": "repositoryUriForDigest", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForDigest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", "parameters": [ { "default": undefined, "displayName": "digest", "docs": { "summary": "Image digest to use (tools usually default to the image with the "latest" tag if omitted).", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForDigest.parameter.digest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", "optional": true, "type": { "formattingPattern": "java.lang.String", }, }, ], "usage": "public java.lang.String repositoryUriForDigest() public java.lang.String repositoryUriForDigest(java.lang.String digest)", }, { "displayName": "repositoryUriForTag", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForTag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", "parameters": [ { "default": undefined, "displayName": "tag", "docs": { "summary": "Image tag to use (tools usually default to "latest" if omitted).", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.repositoryUriForTag.parameter.tag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", "optional": true, "type": { "formattingPattern": "java.lang.String", }, }, ], "usage": "public java.lang.String repositoryUriForTag() public java.lang.String repositoryUriForTag(java.lang.String tag)", }, ], "interfaces": [ { "displayName": "IResource", "fqn": "software.amazon.awscdk.core.IResource", "id": "@aws-cdk/core.IResource", "packageName": "@aws-cdk/core", "packageVersion": "1.106.0", }, ], "properties": [ { "default": undefined, "displayName": "node", "docs": { "summary": "The construct tree node for this construct.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.node", "id": "@aws-cdk/aws-ecr.IRepository.property.node", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ConstructNode", "fqn": "software.amazon.awscdk.core.ConstructNode", "id": "@aws-cdk/core.ConstructNode", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public ConstructNode getNode();", }, { "default": undefined, "displayName": "env", "docs": { "remarks": "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.", "summary": "The environment this resource belongs to.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.env", "id": "@aws-cdk/aws-ecr.IRepository.property.env", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ResourceEnvironment", "fqn": "software.amazon.awscdk.core.ResourceEnvironment", "id": "@aws-cdk/core.ResourceEnvironment", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public ResourceEnvironment getEnv();", }, { "default": undefined, "displayName": "stack", "docs": { "summary": "The stack in which this resource is defined.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.stack", "id": "@aws-cdk/aws-ecr.IRepository.property.stack", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "Stack", "fqn": "software.amazon.awscdk.core.Stack", "id": "@aws-cdk/core.Stack", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public Stack getStack();", }, { "default": undefined, "displayName": "repositoryArn", "docs": { "summary": "The ARN of the repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.repositoryArn", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, "usage": "public java.lang.String getRepositoryArn();", }, { "default": undefined, "displayName": "repositoryName", "docs": { "summary": "The name of the repository.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.repositoryName", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, "usage": "public java.lang.String getRepositoryName();", }, { "default": undefined, "displayName": "repositoryUri", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", "summary": "The URI of this repository (represents the latest image):.", }, "fqn": "software.amazon.awscdk.services.ecr.IRepository.property.repositoryUri", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", "optional": undefined, "type": { "formattingPattern": "java.lang.String", }, "usage": "public java.lang.String getRepositoryUri();", }, ], } `; exports[`java snapshot 2`] = ` " IRepository <a name="IRepository" id="@aws-cdk/aws-ecr.IRepository"></a> - *Extends:* software.amazon.awscdk.core.IResource - *Implemented By:* <a href="#@aws-cdk/aws-ecr.Repository">Repository</a>, <a href="#@aws-cdk/aws-ecr.RepositoryBase">RepositoryBase</a>, <a href="#@aws-cdk/aws-ecr.IRepository">IRepository</a> Represents an ECR repository. # Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.addToResourcePolicy">addToResourcePolicy</a></code> | Add a policy statement to the repository's resource policy. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grant">grant</a></code> | Grant the given principal identity permissions to perform the actions on this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPull">grantPull</a></code> | Grant the given identity permissions to pull images in this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPullPush">grantPullPush</a></code> | Grant the given identity permissions to pull and push images to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent">onCloudTrailEvent</a></code> | Define a CloudWatch event that triggers when something happens to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed">onCloudTrailImagePushed</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onEvent">onEvent</a></code> | Defines a CloudWatch event rule which triggers for repository events. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onImageScanCompleted">onImageScanCompleted</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest">repositoryUriForDigest</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForTag">repositoryUriForTag</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- ## \`addToResourcePolicy\` <a name="addToResourcePolicy" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy"></a> \`\`\`java public AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement) \`\`\` Add a policy statement to the repository's resource policy. ### \`statement\`<sup>Required</sup> <a name="statement" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement"></a> - *Type:* software.amazon.awscdk.services.iam.PolicyStatement --- ## \`grant\` <a name="grant" id="@aws-cdk/aws-ecr.IRepository.grant"></a> \`\`\`java public Grant grant(IGrantable grantee, java.lang.String actions) \`\`\` Grant the given principal identity permissions to perform the actions on this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee"></a> - *Type:* software.amazon.awscdk.services.iam.IGrantable --- ### \`actions\`<sup>Required</sup> <a name="actions" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.actions"></a> - *Type:* java.lang.String --- ## \`grantPull\` <a name="grantPull" id="@aws-cdk/aws-ecr.IRepository.grantPull"></a> \`\`\`java public Grant grantPull(IGrantable grantee) \`\`\` Grant the given identity permissions to pull images in this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee"></a> - *Type:* software.amazon.awscdk.services.iam.IGrantable --- ## \`grantPullPush\` <a name="grantPullPush" id="@aws-cdk/aws-ecr.IRepository.grantPullPush"></a> \`\`\`java public Grant grantPullPush(IGrantable grantee) \`\`\` Grant the given identity permissions to pull and push images to this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee"></a> - *Type:* software.amazon.awscdk.services.iam.IGrantable --- ## \`onCloudTrailEvent\` <a name="onCloudTrailEvent" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent"></a> \`\`\`java public Rule onCloudTrailEvent(java.lang.String id) public Rule onCloudTrailEvent(java.lang.String id, OnEventOptions options) \`\`\` 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id"></a> - *Type:* java.lang.String The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options"></a> - *Type:* software.amazon.awscdk.services.events.OnEventOptions Options for adding the rule. --- ## \`onCloudTrailImagePushed\` <a name="onCloudTrailImagePushed" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed"></a> \`\`\`java public Rule onCloudTrailImagePushed(java.lang.String id) public Rule onCloudTrailImagePushed(java.lang.String id, OnCloudTrailImagePushedOptions options) \`\`\` 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id"></a> - *Type:* java.lang.String The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions">OnCloudTrailImagePushedOptions</a> Options for adding the rule. --- ## \`onEvent\` <a name="onEvent" id="@aws-cdk/aws-ecr.IRepository.onEvent"></a> \`\`\`java public Rule onEvent(java.lang.String id) public Rule onEvent(java.lang.String id, OnEventOptions options) \`\`\` Defines a CloudWatch event rule which triggers for repository events. Use \`rule.addEventPattern(pattern)\` to specify a filter. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id"></a> - *Type:* java.lang.String --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options"></a> - *Type:* software.amazon.awscdk.services.events.OnEventOptions --- ## \`onImageScanCompleted\` <a name="onImageScanCompleted" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted"></a> \`\`\`java public Rule onImageScanCompleted(java.lang.String id) public Rule onImageScanCompleted(java.lang.String id, OnImageScanCompletedOptions options) \`\`\` Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id"></a> - *Type:* java.lang.String The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnImageScanCompletedOptions">OnImageScanCompletedOptions</a> Options for adding the rule. --- ## \`repositoryUriForDigest\` <a name="repositoryUriForDigest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest"></a> \`\`\`java public java.lang.String repositoryUriForDigest() public java.lang.String repositoryUriForDigest(java.lang.String digest) \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST] ### \`digest\`<sup>Optional</sup> <a name="digest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest"></a> - *Type:* java.lang.String Image digest to use (tools usually default to the image with the "latest" tag if omitted). --- ## \`repositoryUriForTag\` <a name="repositoryUriForTag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag"></a> \`\`\`java public java.lang.String repositoryUriForTag() public java.lang.String repositoryUriForTag(java.lang.String tag) \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG] ### \`tag\`<sup>Optional</sup> <a name="tag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag"></a> - *Type:* java.lang.String Image tag to use (tools usually default to "latest" if omitted). --- # Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.node">node</a></code> | <code>software.amazon.awscdk.core.ConstructNode</code> | The construct tree node for this construct. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.env">env</a></code> | <code>software.amazon.awscdk.core.ResourceEnvironment</code> | The environment this resource belongs to. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.stack">stack</a></code> | <code>software.amazon.awscdk.core.Stack</code> | The stack in which this resource is defined. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryArn">repositoryArn</a></code> | <code>java.lang.String</code> | The ARN of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryName">repositoryName</a></code> | <code>java.lang.String</code> | The name of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryUri">repositoryUri</a></code> | <code>java.lang.String</code> | The URI of this repository (represents the latest image):. | --- ## \`node\`<sup>Required</sup> <a name="node" id="@aws-cdk/aws-ecr.IRepository.property.node"></a> \`\`\`java public ConstructNode getNode(); \`\`\` - *Type:* software.amazon.awscdk.core.ConstructNode The construct tree node for this construct. --- ## \`env\`<sup>Required</sup> <a name="env" id="@aws-cdk/aws-ecr.IRepository.property.env"></a> \`\`\`java public ResourceEnvironment getEnv(); \`\`\` - *Type:* software.amazon.awscdk.core.ResourceEnvironment 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. --- ## \`stack\`<sup>Required</sup> <a name="stack" id="@aws-cdk/aws-ecr.IRepository.property.stack"></a> \`\`\`java public Stack getStack(); \`\`\` - *Type:* software.amazon.awscdk.core.Stack The stack in which this resource is defined. --- ## \`repositoryArn\`<sup>Required</sup> <a name="repositoryArn" id="@aws-cdk/aws-ecr.IRepository.property.repositoryArn"></a> \`\`\`java public java.lang.String getRepositoryArn(); \`\`\` - *Type:* java.lang.String The ARN of the repository. --- ## \`repositoryName\`<sup>Required</sup> <a name="repositoryName" id="@aws-cdk/aws-ecr.IRepository.property.repositoryName"></a> \`\`\`java public java.lang.String getRepositoryName(); \`\`\` - *Type:* java.lang.String The name of the repository. --- ## \`repositoryUri\`<sup>Required</sup> <a name="repositoryUri" id="@aws-cdk/aws-ecr.IRepository.property.repositoryUri"></a> \`\`\`java public java.lang.String getRepositoryUri(); \`\`\` - *Type:* java.lang.String The URI of this repository (represents the latest image):. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- " `; exports[`python snapshot 1`] = ` { "displayName": "IRepository", "docs": { "summary": "Represents an ECR repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "implementations": [ { "displayName": "Repository", "fqn": "aws_cdk.aws_ecr.Repository", "id": "@aws-cdk/aws-ecr.Repository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "RepositoryBase", "fqn": "aws_cdk.aws_ecr.RepositoryBase", "id": "@aws-cdk/aws-ecr.RepositoryBase", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "IRepository", "fqn": "aws_cdk.aws_ecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, ], "instanceMethods": [ { "displayName": "add_to_resource_policy", "docs": { "summary": "Add a policy statement to the repository's resource policy.", }, "fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", "parameters": [ { "default": undefined, "displayName": "statement", "docs": {}, "fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy.parameter.statement", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "PolicyStatement", "fqn": "aws_cdk.aws_iam.PolicyStatement", "id": "@aws-cdk/aws-iam.PolicyStatement", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "def add_to_resource_policy( statement: PolicyStatement ) -> AddToResourcePolicyResult", }, { "displayName": "grant", "docs": { "summary": "Grant the given principal identity permissions to perform the actions on this repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository.grant", "id": "@aws-cdk/aws-ecr.IRepository.grant", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "aws_cdk.aws_iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, { "default": undefined, "displayName": "actions", "docs": {}, "fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.actions", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", "optional": undefined, "type": { "formattingPattern": "str", }, }, ], "usage": "def grant( grantee: IGrantable, actions: str ) -> Grant", }, { "displayName": "grant_pull", "docs": { "summary": "Grant the given identity permissions to pull images in this repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull", "id": "@aws-cdk/aws-ecr.IRepository.grantPull", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "aws_cdk.aws_iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "def grant_pull( grantee: IGrantable ) -> Grant", }, { "displayName": "grant_pull_push", "docs": { "summary": "Grant the given identity permissions to pull and push images to this repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "aws_cdk.aws_iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "def grant_pull_push( grantee: IGrantable ) -> Grant", }, { "displayName": "on_cloud_trail_event", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Define a CloudWatch event that triggers when something happens to this repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "str", }, }, { "default": "- No description", "displayName": "description", "docs": { "summary": "A description of the rule's purpose.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.description", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.description", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No additional filtering based on an event pattern.", "displayName": "event_pattern", "docs": { "links": [ "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", ], "remarks": "The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.", "summary": "Additional restrictions for the event to route to the specified target.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.event_pattern", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.eventPattern", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "EventPattern", "fqn": "aws_cdk.aws_events.EventPattern", "id": "@aws-cdk/aws-events.EventPattern", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, { "default": "AWS CloudFormation generates a unique physical ID.", "displayName": "rule_name", "docs": { "summary": "A name for the rule.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.rule_name", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.ruleName", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", "displayName": "target", "docs": { "summary": "The target to register for the event.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.target", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.target", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "IRuleTarget", "fqn": "aws_cdk.aws_events.IRuleTarget", "id": "@aws-cdk/aws-events.IRuleTarget", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "def on_cloud_trail_event( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None ) -> Rule", }, { "displayName": "on_cloud_trail_image_pushed", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", "optional": undefined, "type": { "formattingPattern": "str", }, }, { "default": "- No description", "displayName": "description", "docs": { "summary": "A description of the rule's purpose.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.description", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.description", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No additional filtering based on an event pattern.", "displayName": "event_pattern", "docs": { "links": [ "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", ], "remarks": "The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.", "summary": "Additional restrictions for the event to route to the specified target.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.event_pattern", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.eventPattern", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "EventPattern", "fqn": "aws_cdk.aws_events.EventPattern", "id": "@aws-cdk/aws-events.EventPattern", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, { "default": "AWS CloudFormation generates a unique physical ID.", "displayName": "rule_name", "docs": { "summary": "A name for the rule.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.rule_name", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.ruleName", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", "displayName": "target", "docs": { "summary": "The target to register for the event.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.target", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.target", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "IRuleTarget", "fqn": "aws_cdk.aws_events.IRuleTarget", "id": "@aws-cdk/aws-events.IRuleTarget", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, { "default": "- Watch changes to all tags", "displayName": "image_tag", "docs": { "summary": "Only watch changes to this image tag.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.image_tag", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.imageTag", "optional": true, "type": { "formattingPattern": "str", }, }, ], "usage": "def on_cloud_trail_image_pushed( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None, image_tag: str = None ) -> Rule", }, { "displayName": "on_event", "docs": { "remarks": "Use \`rule.addEventPattern(pattern)\` to specify a filter.", "summary": "Defines a CloudWatch event rule which triggers for repository events.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_event", "id": "@aws-cdk/aws-ecr.IRepository.onEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": {}, "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "str", }, }, { "default": "- No description", "displayName": "description", "docs": { "summary": "A description of the rule's purpose.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.description", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.description", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No additional filtering based on an event pattern.", "displayName": "event_pattern", "docs": { "links": [ "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", ], "remarks": "The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.", "summary": "Additional restrictions for the event to route to the specified target.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.event_pattern", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.eventPattern", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "EventPattern", "fqn": "aws_cdk.aws_events.EventPattern", "id": "@aws-cdk/aws-events.EventPattern", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, { "default": "AWS CloudFormation generates a unique physical ID.", "displayName": "rule_name", "docs": { "summary": "A name for the rule.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.rule_name", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.ruleName", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", "displayName": "target", "docs": { "summary": "The target to register for the event.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.target", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.target", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "IRuleTarget", "fqn": "aws_cdk.aws_events.IRuleTarget", "id": "@aws-cdk/aws-events.IRuleTarget", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "def on_event( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None ) -> Rule", }, { "displayName": "on_image_scan_completed", "docs": { "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", "optional": undefined, "type": { "formattingPattern": "str", }, }, { "default": "- No description", "displayName": "description", "docs": { "summary": "A description of the rule's purpose.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.description", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.description", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No additional filtering based on an event pattern.", "displayName": "event_pattern", "docs": { "links": [ "https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html", ], "remarks": "The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.", "summary": "Additional restrictions for the event to route to the specified target.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.event_pattern", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.eventPattern", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "EventPattern", "fqn": "aws_cdk.aws_events.EventPattern", "id": "@aws-cdk/aws-events.EventPattern", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, { "default": "AWS CloudFormation generates a unique physical ID.", "displayName": "rule_name", "docs": { "summary": "A name for the rule.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.rule_name", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.ruleName", "optional": true, "type": { "formattingPattern": "str", }, }, { "default": "- No target is added to the rule. Use \`addTarget()\` to add a target.", "displayName": "target", "docs": { "summary": "The target to register for the event.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.target", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.target", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "IRuleTarget", "fqn": "aws_cdk.aws_events.IRuleTarget", "id": "@aws-cdk/aws-events.IRuleTarget", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, { "default": "- Watch the changes to the repository with all image tags", "displayName": "image_tags", "docs": { "remarks": "Leave it undefined to watch the full repository.", "summary": "Only watch changes to the image tags spedified.", }, "fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.image_tags", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.imageTags", "optional": true, "type": { "formattingPattern": "typing.List[%]", "types": [ { "formattingPattern": "str", }, ], }, }, ], "usage": "def on_image_scan_completed( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None, image_tags: typing.List[str] = None ) -> Rule", }, { "displayName": "repository_uri_for_digest", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", "parameters": [ { "default": undefined, "displayName": "digest", "docs": { "summary": "Image digest to use (tools usually default to the image with the "latest" tag if omitted).", }, "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest.parameter.digest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", "optional": true, "type": { "formattingPattern": "str", }, }, ], "usage": "def repository_uri_for_digest( digest: str = None ) -> str", }, { "displayName": "repository_uri_for_tag", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", "parameters": [ { "default": undefined, "displayName": "tag", "docs": { "summary": "Image tag to use (tools usually default to "latest" if omitted).", }, "fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag.parameter.tag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", "optional": true, "type": { "formattingPattern": "str", }, }, ], "usage": "def repository_uri_for_tag( tag: str = None ) -> str", }, ], "interfaces": [ { "displayName": "IResource", "fqn": "aws_cdk.core.IResource", "id": "@aws-cdk/core.IResource", "packageName": "@aws-cdk/core", "packageVersion": "1.106.0", }, ], "properties": [ { "default": undefined, "displayName": "node", "docs": { "summary": "The construct tree node for this construct.", }, "fqn": "aws_cdk.aws_ecr.IRepository.property.node", "id": "@aws-cdk/aws-ecr.IRepository.property.node", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ConstructNode", "fqn": "aws_cdk.core.ConstructNode", "id": "@aws-cdk/core.ConstructNode", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "node: ConstructNode", }, { "default": undefined, "displayName": "env", "docs": { "remarks": "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.", "summary": "The environment this resource belongs to.", }, "fqn": "aws_cdk.aws_ecr.IRepository.property.env", "id": "@aws-cdk/aws-ecr.IRepository.property.env", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ResourceEnvironment", "fqn": "aws_cdk.core.ResourceEnvironment", "id": "@aws-cdk/core.ResourceEnvironment", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "env: ResourceEnvironment", }, { "default": undefined, "displayName": "stack", "docs": { "summary": "The stack in which this resource is defined.", }, "fqn": "aws_cdk.aws_ecr.IRepository.property.stack", "id": "@aws-cdk/aws-ecr.IRepository.property.stack", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "Stack", "fqn": "aws_cdk.core.Stack", "id": "@aws-cdk/core.Stack", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "stack: Stack", }, { "default": undefined, "displayName": "repository_arn", "docs": { "summary": "The ARN of the repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_arn", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", "optional": undefined, "type": { "formattingPattern": "str", }, "usage": "repository_arn: str", }, { "default": undefined, "displayName": "repository_name", "docs": { "summary": "The name of the repository.", }, "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_name", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", "optional": undefined, "type": { "formattingPattern": "str", }, "usage": "repository_name: str", }, { "default": undefined, "displayName": "repository_uri", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", "summary": "The URI of this repository (represents the latest image):.", }, "fqn": "aws_cdk.aws_ecr.IRepository.property.repository_uri", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", "optional": undefined, "type": { "formattingPattern": "str", }, "usage": "repository_uri: str", }, ], } `; exports[`python snapshot 2`] = ` " IRepository <a name="IRepository" id="@aws-cdk/aws-ecr.IRepository"></a> - *Extends:* aws_cdk.core.IResource - *Implemented By:* <a href="#@aws-cdk/aws-ecr.Repository">Repository</a>, <a href="#@aws-cdk/aws-ecr.RepositoryBase">RepositoryBase</a>, <a href="#@aws-cdk/aws-ecr.IRepository">IRepository</a> Represents an ECR repository. # Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.addToResourcePolicy">add_to_resource_policy</a></code> | Add a policy statement to the repository's resource policy. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grant">grant</a></code> | Grant the given principal identity permissions to perform the actions on this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPull">grant_pull</a></code> | Grant the given identity permissions to pull images in this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPullPush">grant_pull_push</a></code> | Grant the given identity permissions to pull and push images to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent">on_cloud_trail_event</a></code> | Define a CloudWatch event that triggers when something happens to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed">on_cloud_trail_image_pushed</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onEvent">on_event</a></code> | Defines a CloudWatch event rule which triggers for repository events. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onImageScanCompleted">on_image_scan_completed</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest">repository_uri_for_digest</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForTag">repository_uri_for_tag</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- ## \`add_to_resource_policy\` <a name="add_to_resource_policy" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy"></a> \`\`\`python def add_to_resource_policy( statement: PolicyStatement ) -> AddToResourcePolicyResult \`\`\` Add a policy statement to the repository's resource policy. ### \`statement\`<sup>Required</sup> <a name="statement" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement"></a> - *Type:* aws_cdk.aws_iam.PolicyStatement --- ## \`grant\` <a name="grant" id="@aws-cdk/aws-ecr.IRepository.grant"></a> \`\`\`python def grant( grantee: IGrantable, actions: str ) -> Grant \`\`\` Grant the given principal identity permissions to perform the actions on this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee"></a> - *Type:* aws_cdk.aws_iam.IGrantable --- ### \`actions\`<sup>Required</sup> <a name="actions" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.actions"></a> - *Type:* str --- ## \`grant_pull\` <a name="grant_pull" id="@aws-cdk/aws-ecr.IRepository.grantPull"></a> \`\`\`python def grant_pull( grantee: IGrantable ) -> Grant \`\`\` Grant the given identity permissions to pull images in this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee"></a> - *Type:* aws_cdk.aws_iam.IGrantable --- ## \`grant_pull_push\` <a name="grant_pull_push" id="@aws-cdk/aws-ecr.IRepository.grantPullPush"></a> \`\`\`python def grant_pull_push( grantee: IGrantable ) -> Grant \`\`\` Grant the given identity permissions to pull and push images to this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee"></a> - *Type:* aws_cdk.aws_iam.IGrantable --- ## \`on_cloud_trail_event\` <a name="on_cloud_trail_event" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent"></a> \`\`\`python def on_cloud_trail_event( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None ) -> 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id"></a> - *Type:* str The id of the rule. --- ### \`description\`<sup>Optional</sup> <a name="description" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.description"></a> - *Type:* str - *Default:* No description A description of the rule's purpose. --- ### \`event_pattern\`<sup>Optional</sup> <a name="event_pattern" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.eventPattern"></a> - *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. > [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- ### \`rule_name\`<sup>Optional</sup> <a name="rule_name" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.ruleName"></a> - *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- ### \`target\`<sup>Optional</sup> <a name="target" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.target"></a> - *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- ## \`on_cloud_trail_image_pushed\` <a name="on_cloud_trail_image_pushed" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed"></a> \`\`\`python def on_cloud_trail_image_pushed( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None, image_tag: str = None ) -> 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id"></a> - *Type:* str The id of the rule. --- ### \`description\`<sup>Optional</sup> <a name="description" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.description"></a> - *Type:* str - *Default:* No description A description of the rule's purpose. --- ### \`event_pattern\`<sup>Optional</sup> <a name="event_pattern" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.eventPattern"></a> - *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. > [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- ### \`rule_name\`<sup>Optional</sup> <a name="rule_name" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.ruleName"></a> - *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- ### \`target\`<sup>Optional</sup> <a name="target" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.target"></a> - *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- ### \`image_tag\`<sup>Optional</sup> <a name="image_tag" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.imageTag"></a> - *Type:* str - *Default:* Watch changes to all tags Only watch changes to this image tag. --- ## \`on_event\` <a name="on_event" id="@aws-cdk/aws-ecr.IRepository.onEvent"></a> \`\`\`python def on_event( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None ) -> Rule \`\`\` Defines a CloudWatch event rule which triggers for repository events. Use \`rule.addEventPattern(pattern)\` to specify a filter. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id"></a> - *Type:* str --- ### \`description\`<sup>Optional</sup> <a name="description" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.description"></a> - *Type:* str - *Default:* No description A description of the rule's purpose. --- ### \`event_pattern\`<sup>Optional</sup> <a name="event_pattern" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.eventPattern"></a> - *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. > [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- ### \`rule_name\`<sup>Optional</sup> <a name="rule_name" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.ruleName"></a> - *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- ### \`target\`<sup>Optional</sup> <a name="target" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.target"></a> - *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- ## \`on_image_scan_completed\` <a name="on_image_scan_completed" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted"></a> \`\`\`python def on_image_scan_completed( id: str, description: str = None, event_pattern: EventPattern = None, rule_name: str = None, target: IRuleTarget = None, image_tags: typing.List[str] = None ) -> Rule \`\`\` Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id"></a> - *Type:* str The id of the rule. --- ### \`description\`<sup>Optional</sup> <a name="description" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.description"></a> - *Type:* str - *Default:* No description A description of the rule's purpose. --- ### \`event_pattern\`<sup>Optional</sup> <a name="event_pattern" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.eventPattern"></a> - *Type:* aws_cdk.aws_events.EventPattern - *Default:* No additional filtering based on an event pattern. Additional restrictions for the event to route to the specified target. The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering. > [https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) --- ### \`rule_name\`<sup>Optional</sup> <a name="rule_name" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.ruleName"></a> - *Type:* str - *Default:* AWS CloudFormation generates a unique physical ID. A name for the rule. --- ### \`target\`<sup>Optional</sup> <a name="target" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.target"></a> - *Type:* aws_cdk.aws_events.IRuleTarget - *Default:* No target is added to the rule. Use \`addTarget()\` to add a target. The target to register for the event. --- ### \`image_tags\`<sup>Optional</sup> <a name="image_tags" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.imageTags"></a> - *Type:* typing.List[str] - *Default:* Watch the changes to the repository with all image tags Only watch changes to the image tags spedified. Leave it undefined to watch the full repository. --- ## \`repository_uri_for_digest\` <a name="repository_uri_for_digest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest"></a> \`\`\`python def repository_uri_for_digest( digest: str = None ) -> str \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST] ### \`digest\`<sup>Optional</sup> <a name="digest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest"></a> - *Type:* str Image digest to use (tools usually default to the image with the "latest" tag if omitted). --- ## \`repository_uri_for_tag\` <a name="repository_uri_for_tag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag"></a> \`\`\`python def repository_uri_for_tag( tag: str = None ) -> str \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG] ### \`tag\`<sup>Optional</sup> <a name="tag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag"></a> - *Type:* str Image tag to use (tools usually default to "latest" if omitted). --- # Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.node">node</a></code> | <code>aws_cdk.core.ConstructNode</code> | The construct tree node for this construct. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.env">env</a></code> | <code>aws_cdk.core.ResourceEnvironment</code> | The environment this resource belongs to. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.stack">stack</a></code> | <code>aws_cdk.core.Stack</code> | The stack in which this resource is defined. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryArn">repository_arn</a></code> | <code>str</code> | The ARN of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryName">repository_name</a></code> | <code>str</code> | The name of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryUri">repository_uri</a></code> | <code>str</code> | The URI of this repository (represents the latest image):. | --- ## \`node\`<sup>Required</sup> <a name="node" id="@aws-cdk/aws-ecr.IRepository.property.node"></a> \`\`\`python node: ConstructNode \`\`\` - *Type:* aws_cdk.core.ConstructNode The construct tree node for this construct. --- ## \`env\`<sup>Required</sup> <a name="env" id="@aws-cdk/aws-ecr.IRepository.property.env"></a> \`\`\`python env: ResourceEnvironment \`\`\` - *Type:* aws_cdk.core.ResourceEnvironment 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. --- ## \`stack\`<sup>Required</sup> <a name="stack" id="@aws-cdk/aws-ecr.IRepository.property.stack"></a> \`\`\`python stack: Stack \`\`\` - *Type:* aws_cdk.core.Stack The stack in which this resource is defined. --- ## \`repository_arn\`<sup>Required</sup> <a name="repository_arn" id="@aws-cdk/aws-ecr.IRepository.property.repositoryArn"></a> \`\`\`python repository_arn: str \`\`\` - *Type:* str The ARN of the repository. --- ## \`repository_name\`<sup>Required</sup> <a name="repository_name" id="@aws-cdk/aws-ecr.IRepository.property.repositoryName"></a> \`\`\`python repository_name: str \`\`\` - *Type:* str The name of the repository. --- ## \`repository_uri\`<sup>Required</sup> <a name="repository_uri" id="@aws-cdk/aws-ecr.IRepository.property.repositoryUri"></a> \`\`\`python repository_uri: str \`\`\` - *Type:* str The URI of this repository (represents the latest image):. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- " `; exports[`typescript snapshot 1`] = ` { "displayName": "IRepository", "docs": { "summary": "Represents an ECR repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "implementations": [ { "displayName": "Repository", "fqn": "@aws-cdk/aws-ecr.Repository", "id": "@aws-cdk/aws-ecr.Repository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "RepositoryBase", "fqn": "@aws-cdk/aws-ecr.RepositoryBase", "id": "@aws-cdk/aws-ecr.RepositoryBase", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, { "displayName": "IRepository", "fqn": "@aws-cdk/aws-ecr.IRepository", "id": "@aws-cdk/aws-ecr.IRepository", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "1.106.0", }, ], "instanceMethods": [ { "displayName": "addToResourcePolicy", "docs": { "summary": "Add a policy statement to the repository's resource policy.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy", "parameters": [ { "default": undefined, "displayName": "statement", "docs": {}, "fqn": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", "id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "PolicyStatement", "fqn": "@aws-cdk/aws-iam.PolicyStatement", "id": "@aws-cdk/aws-iam.PolicyStatement", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult", }, { "displayName": "grant", "docs": { "summary": "Grant the given principal identity permissions to perform the actions on this repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.grant", "id": "@aws-cdk/aws-ecr.IRepository.grant", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "@aws-cdk/aws-iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, { "default": undefined, "displayName": "actions", "docs": {}, "fqn": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", "id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions", "optional": undefined, "type": { "formattingPattern": "string", }, }, ], "usage": "public grant(grantee: IGrantable, actions: string): Grant", }, { "displayName": "grantPull", "docs": { "summary": "Grant the given identity permissions to pull images in this repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.grantPull", "id": "@aws-cdk/aws-ecr.IRepository.grantPull", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "@aws-cdk/aws-iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public grantPull(grantee: IGrantable): Grant", }, { "displayName": "grantPullPush", "docs": { "summary": "Grant the given identity permissions to pull and push images to this repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.grantPullPush", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush", "parameters": [ { "default": undefined, "displayName": "grantee", "docs": {}, "fqn": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", "id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "IGrantable", "fqn": "@aws-cdk/aws-iam.IGrantable", "id": "@aws-cdk/aws-iam.IGrantable", "packageName": "@aws-cdk/aws-iam", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public grantPullPush(grantee: IGrantable): Grant", }, { "displayName": "onCloudTrailEvent", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Define a CloudWatch event that triggers when something happens to this repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "@aws-cdk/aws-events.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public onCloudTrailEvent(id: string, options?: OnEventOptions): Rule", }, { "displayName": "onCloudTrailImagePushed", "docs": { "remarks": "Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.", "summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnCloudTrailImagePushedOptions", "fqn": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", "id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions): Rule", }, { "displayName": "onEvent", "docs": { "remarks": "Use \`rule.addEventPattern(pattern)\` to specify a filter.", "summary": "Defines a CloudWatch event rule which triggers for repository events.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onEvent", "id": "@aws-cdk/aws-ecr.IRepository.onEvent", "parameters": [ { "default": undefined, "displayName": "id", "docs": {}, "fqn": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "options", "docs": {}, "fqn": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnEventOptions", "fqn": "@aws-cdk/aws-events.OnEventOptions", "id": "@aws-cdk/aws-events.OnEventOptions", "packageName": "@aws-cdk/aws-events", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public onEvent(id: string, options?: OnEventOptions): Rule", }, { "displayName": "onImageScanCompleted", "docs": { "summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted", "parameters": [ { "default": undefined, "displayName": "id", "docs": { "summary": "The id of the rule.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id", "optional": undefined, "type": { "formattingPattern": "string", }, }, { "default": undefined, "displayName": "options", "docs": { "summary": "Options for adding the rule.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", "id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options", "optional": true, "type": { "formattingPattern": "%", "types": [ { "displayName": "OnImageScanCompletedOptions", "fqn": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", "id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions", "packageName": "@aws-cdk/aws-ecr", "packageVersion": "99.99.99", }, ], }, }, ], "usage": "public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions): Rule", }, { "displayName": "repositoryUriForDigest", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest", "parameters": [ { "default": undefined, "displayName": "digest", "docs": { "summary": "Image digest to use (tools usually default to the image with the "latest" tag if omitted).", }, "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest", "optional": true, "type": { "formattingPattern": "string", }, }, ], "usage": "public repositoryUriForDigest(digest?: string): string", }, { "displayName": "repositoryUriForTag", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]", "summary": "Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag", "parameters": [ { "default": undefined, "displayName": "tag", "docs": { "summary": "Image tag to use (tools usually default to "latest" if omitted).", }, "fqn": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", "id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag", "optional": true, "type": { "formattingPattern": "string", }, }, ], "usage": "public repositoryUriForTag(tag?: string): string", }, ], "interfaces": [ { "displayName": "IResource", "fqn": "@aws-cdk/core.IResource", "id": "@aws-cdk/core.IResource", "packageName": "@aws-cdk/core", "packageVersion": "1.106.0", }, ], "properties": [ { "default": undefined, "displayName": "node", "docs": { "summary": "The construct tree node for this construct.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.property.node", "id": "@aws-cdk/aws-ecr.IRepository.property.node", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ConstructNode", "fqn": "@aws-cdk/core.ConstructNode", "id": "@aws-cdk/core.ConstructNode", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public readonly node: ConstructNode;", }, { "default": undefined, "displayName": "env", "docs": { "remarks": "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.", "summary": "The environment this resource belongs to.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.property.env", "id": "@aws-cdk/aws-ecr.IRepository.property.env", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "ResourceEnvironment", "fqn": "@aws-cdk/core.ResourceEnvironment", "id": "@aws-cdk/core.ResourceEnvironment", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public readonly env: ResourceEnvironment;", }, { "default": undefined, "displayName": "stack", "docs": { "summary": "The stack in which this resource is defined.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.property.stack", "id": "@aws-cdk/aws-ecr.IRepository.property.stack", "optional": undefined, "type": { "formattingPattern": "%", "types": [ { "displayName": "Stack", "fqn": "@aws-cdk/core.Stack", "id": "@aws-cdk/core.Stack", "packageName": "@aws-cdk/core", "packageVersion": "99.99.99", }, ], }, "usage": "public readonly stack: Stack;", }, { "default": undefined, "displayName": "repositoryArn", "docs": { "summary": "The ARN of the repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn", "optional": undefined, "type": { "formattingPattern": "string", }, "usage": "public readonly repositoryArn: string;", }, { "default": undefined, "displayName": "repositoryName", "docs": { "summary": "The name of the repository.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName", "optional": undefined, "type": { "formattingPattern": "string", }, "usage": "public readonly repositoryName: string;", }, { "default": undefined, "displayName": "repositoryUri", "docs": { "remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY", "summary": "The URI of this repository (represents the latest image):.", }, "fqn": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", "id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri", "optional": undefined, "type": { "formattingPattern": "string", }, "usage": "public readonly repositoryUri: string;", }, ], } `; exports[`typescript snapshot 2`] = ` " IRepository <a name="IRepository" id="@aws-cdk/aws-ecr.IRepository"></a> - *Extends:* @aws-cdk/core.IResource - *Implemented By:* <a href="#@aws-cdk/aws-ecr.Repository">Repository</a>, <a href="#@aws-cdk/aws-ecr.RepositoryBase">RepositoryBase</a>, <a href="#@aws-cdk/aws-ecr.IRepository">IRepository</a> Represents an ECR repository. # Methods <a name="Methods" id="Methods"></a> | **Name** | **Description** | | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.addToResourcePolicy">addToResourcePolicy</a></code> | Add a policy statement to the repository's resource policy. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grant">grant</a></code> | Grant the given principal identity permissions to perform the actions on this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPull">grantPull</a></code> | Grant the given identity permissions to pull images in this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.grantPullPush">grantPullPush</a></code> | Grant the given identity permissions to pull and push images to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent">onCloudTrailEvent</a></code> | Define a CloudWatch event that triggers when something happens to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed">onCloudTrailImagePushed</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onEvent">onEvent</a></code> | Defines a CloudWatch event rule which triggers for repository events. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.onImageScanCompleted">onImageScanCompleted</a></code> | Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest">repositoryUriForDigest</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.repositoryUriForTag">repositoryUriForTag</a></code> | Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. | --- ## \`addToResourcePolicy\` <a name="addToResourcePolicy" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy"></a> \`\`\`typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult \`\`\` Add a policy statement to the repository's resource policy. ### \`statement\`<sup>Required</sup> <a name="statement" id="@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement"></a> - *Type:* @aws-cdk/aws-iam.PolicyStatement --- ## \`grant\` <a name="grant" id="@aws-cdk/aws-ecr.IRepository.grant"></a> \`\`\`typescript public grant(grantee: IGrantable, actions: string): Grant \`\`\` Grant the given principal identity permissions to perform the actions on this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee"></a> - *Type:* @aws-cdk/aws-iam.IGrantable --- ### \`actions\`<sup>Required</sup> <a name="actions" id="@aws-cdk/aws-ecr.IRepository.grant.parameter.actions"></a> - *Type:* string --- ## \`grantPull\` <a name="grantPull" id="@aws-cdk/aws-ecr.IRepository.grantPull"></a> \`\`\`typescript public grantPull(grantee: IGrantable): Grant \`\`\` Grant the given identity permissions to pull images in this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee"></a> - *Type:* @aws-cdk/aws-iam.IGrantable --- ## \`grantPullPush\` <a name="grantPullPush" id="@aws-cdk/aws-ecr.IRepository.grantPullPush"></a> \`\`\`typescript public grantPullPush(grantee: IGrantable): Grant \`\`\` Grant the given identity permissions to pull and push images to this repository. ### \`grantee\`<sup>Required</sup> <a name="grantee" id="@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee"></a> - *Type:* @aws-cdk/aws-iam.IGrantable --- ## \`onCloudTrailEvent\` <a name="onCloudTrailEvent" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent"></a> \`\`\`typescript public onCloudTrailEvent(id: string, options?: OnEventOptions): 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id"></a> - *Type:* string The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.options"></a> - *Type:* @aws-cdk/aws-events.OnEventOptions Options for adding the rule. --- ## \`onCloudTrailImagePushed\` <a name="onCloudTrailImagePushed" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed"></a> \`\`\`typescript public onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions): 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. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id"></a> - *Type:* string The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions">OnCloudTrailImagePushedOptions</a> Options for adding the rule. --- ## \`onEvent\` <a name="onEvent" id="@aws-cdk/aws-ecr.IRepository.onEvent"></a> \`\`\`typescript public onEvent(id: string, options?: OnEventOptions): Rule \`\`\` Defines a CloudWatch event rule which triggers for repository events. Use \`rule.addEventPattern(pattern)\` to specify a filter. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id"></a> - *Type:* string --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onEvent.parameter.options"></a> - *Type:* @aws-cdk/aws-events.OnEventOptions --- ## \`onImageScanCompleted\` <a name="onImageScanCompleted" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted"></a> \`\`\`typescript public onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions): Rule \`\`\` Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed. ### \`id\`<sup>Required</sup> <a name="id" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id"></a> - *Type:* string The id of the rule. --- ### \`options\`<sup>Optional</sup> <a name="options" id="@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.options"></a> - *Type:* <a href="#@aws-cdk/aws-ecr.OnImageScanCompletedOptions">OnImageScanCompletedOptions</a> Options for adding the rule. --- ## \`repositoryUriForDigest\` <a name="repositoryUriForDigest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest"></a> \`\`\`typescript public repositoryUriForDigest(digest?: string): string \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST] ### \`digest\`<sup>Optional</sup> <a name="digest" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest"></a> - *Type:* string Image digest to use (tools usually default to the image with the "latest" tag if omitted). --- ## \`repositoryUriForTag\` <a name="repositoryUriForTag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag"></a> \`\`\`typescript public repositoryUriForTag(tag?: string): string \`\`\` Returns the URI of the repository for a certain tag. Can be used in \`docker push/pull\`. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG] ### \`tag\`<sup>Optional</sup> <a name="tag" id="@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag"></a> - *Type:* string Image tag to use (tools usually default to "latest" if omitted). --- # Properties <a name="Properties" id="Properties"></a> | **Name** | **Type** | **Description** | | --- | --- | --- | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.node">node</a></code> | <code>@aws-cdk/core.ConstructNode</code> | The construct tree node for this construct. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.env">env</a></code> | <code>@aws-cdk/core.ResourceEnvironment</code> | The environment this resource belongs to. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.stack">stack</a></code> | <code>@aws-cdk/core.Stack</code> | The stack in which this resource is defined. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryArn">repositoryArn</a></code> | <code>string</code> | The ARN of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryName">repositoryName</a></code> | <code>string</code> | The name of the repository. | | <code><a href="#@aws-cdk/aws-ecr.IRepository.property.repositoryUri">repositoryUri</a></code> | <code>string</code> | The URI of this repository (represents the latest image):. | --- ## \`node\`<sup>Required</sup> <a name="node" id="@aws-cdk/aws-ecr.IRepository.property.node"></a> \`\`\`typescript public readonly node: ConstructNode; \`\`\` - *Type:* @aws-cdk/core.ConstructNode The construct tree node for this construct. --- ## \`env\`<sup>Required</sup> <a name="env" id="@aws-cdk/aws-ecr.IRepository.property.env"></a> \`\`\`typescript public readonly env: ResourceEnvironment; \`\`\` - *Type:* @aws-cdk/core.ResourceEnvironment 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. --- ## \`stack\`<sup>Required</sup> <a name="stack" id="@aws-cdk/aws-ecr.IRepository.property.stack"></a> \`\`\`typescript public readonly stack: Stack; \`\`\` - *Type:* @aws-cdk/core.Stack The stack in which this resource is defined. --- ## \`repositoryArn\`<sup>Required</sup> <a name="repositoryArn" id="@aws-cdk/aws-ecr.IRepository.property.repositoryArn"></a> \`\`\`typescript public readonly repositoryArn: string; \`\`\` - *Type:* string The ARN of the repository. --- ## \`repositoryName\`<sup>Required</sup> <a name="repositoryName" id="@aws-cdk/aws-ecr.IRepository.property.repositoryName"></a> \`\`\`typescript public readonly repositoryName: string; \`\`\` - *Type:* string The name of the repository. --- ## \`repositoryUri\`<sup>Required</sup> <a name="repositoryUri" id="@aws-cdk/aws-ecr.IRepository.property.repositoryUri"></a> \`\`\`typescript public readonly repositoryUri: string; \`\`\` - *Type:* string The URI of this repository (represents the latest image):. ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY --- " `;