Repository L2 construct
Define an ECR repository.
Example
const repository = new ecr.Repository(this, 'TestRepository');
const runtime = new agentcore.Runtime(this, 'Runtime', {
agentRuntimeArtifact: agentcore.AgentRuntimeArtifact.fromEcrRepository(repository, 'v1.0.0'),
});
new logs.MetricFilter(this, 'ToolErrors', {
logGroup: runtime.applicationLogGroup,
filterPattern: logs.FilterPattern.stringValue('$.tool_status', '=', 'error'),
metricNamespace: 'MyApp',
metricName: 'ToolExecutionErrors',
});
repository = ecr.Repository(self, "TestRepository")
runtime = agentcore.Runtime(self, "Runtime",
agent_runtime_artifact=agentcore.AgentRuntimeArtifact.from_ecr_repository(repository, "v1.0.0")
)
logs.MetricFilter(self, "ToolErrors",
log_group=runtime.application_log_group,
filter_pattern=logs.FilterPattern.string_value("$.tool_status", "=", "error"),
metric_namespace="MyApp",
metric_name="ToolExecutionErrors"
)
Repository repository = new Repository(this, "TestRepository");
Runtime runtime = Runtime.Builder.create(this, "Runtime")
.agentRuntimeArtifact(AgentRuntimeArtifact.fromEcrRepository(repository, "v1.0.0"))
.build();
MetricFilter.Builder.create(this, "ToolErrors")
.logGroup(runtime.getApplicationLogGroup())
.filterPattern(FilterPattern.stringValue("$.tool_status", "=", "error"))
.metricNamespace("MyApp")
.metricName("ToolExecutionErrors")
.build();
// Install: dotnet add package Amazon.CDK.Lib
var repository = new Repository(this, "TestRepository");
var runtime = new Runtime(this, "Runtime", new RuntimeProps {
AgentRuntimeArtifact = AgentRuntimeArtifact.FromEcrRepository(repository, "v1.0.0")
});
new MetricFilter(this, "ToolErrors", new MetricFilterProps {
LogGroup = runtime.ApplicationLogGroup,
FilterPattern = FilterPattern.StringValue("$.tool_status", "=", "error"),
MetricNamespace = "MyApp",
MetricName = "ToolExecutionErrors"
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
repository := ecr.NewRepository(this, jsii.String("TestRepository"))
runtime := agentcore.NewRuntime(this, jsii.String("Runtime"), &RuntimeProps{
AgentRuntimeArtifact: agentcore.AgentRuntimeArtifact_FromEcrRepository(repository, jsii.String("v1.0.0")),
})
logs.NewMetricFilter(this, jsii.String("ToolErrors"), &MetricFilterProps{
LogGroup: runtime.applicationLogGroup,
FilterPattern: logs.FilterPattern_StringValue(jsii.String("$.tool_status"), jsii.String("="), jsii.String("error")),
MetricNamespace: jsii.String("MyApp"),
MetricName: jsii.String("ToolExecutionErrors"),
})
Initializer
new Repository(scope: Construct, id: string, props?: RepositoryProps)
Repository(scope: Construct, id: str, props: typing.Optional[RepositoryProps] = None)
new Repository(Construct scope, String id, RepositoryProps props)
new Repository(Construct scope, string id, RepositoryProps? props = null)
NewRepository(Scope Construct, Id *string, Props RepositoryProps)
Construct Props
autoDeleteImagesbooleanauto_delete_imagesboolautoDeleteImagesBooleanAutoDeleteImagesboolAutoDeleteImages*bool= falsedeprecated#Requires the removalPolicy to be set to RemovalPolicy.DESTROY.
emptyOnDeletebooleanempty_on_deleteboolemptyOnDeleteBooleanEmptyOnDeleteboolEmptyOnDelete*bool= false#If false, the repository must be empty before attempting to delete it.
encryptionRepositoryEncryptionencryptionRepositoryEncryptionencryptionRepositoryEncryptionEncryptionRepositoryEncryptionEncryptionRepositoryEncryption= `KMS` if `encryptionKey` is spec…#If you choose KMS, you can specify a KMS key via encryptionKey. If encryptionKey is not specified, an AWS managed KMS key is used.
default
Default: KMS if encryptionKey is specified, or AES256 otherwise.
encryptionKeyIKeyRefencryption_keyIKeyRefencryptionKeyIKeyRefEncryptionKeyIKeyRefEncryptionKeyIKeyRef= If encryption is set to `KMS` an…#The 'encryption' property must be either not specified or set to "KMS". An error will be emitted if encryption is set to "AES256".
default
Default: If encryption is set to KMS and this property is undefined, an AWS managed KMS key is used.
imageScanOnPushbooleanimage_scan_on_pushboolimageScanOnPushBooleanImageScanOnPushboolImageScanOnPush*bool= false#imageTagMutabilityTagMutabilityimage_tag_mutabilityTagMutabilityimageTagMutabilityTagMutabilityImageTagMutabilityTagMutabilityImageTagMutabilityTagMutability= TagMutability.MUTABLE#If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten.
imageTagMutabilityExclusionFiltersImageTagMutabilityExclusionFilter[]image_tag_mutability_exclusion_filterstyping.List[ImageTagMutabilityExclusionFilter]imageTagMutabilityExclusionFiltersList<ImageTagMutabilityExclusionFilter>ImageTagMutabilityExclusionFiltersImageTagMutabilityExclusionFilter[]ImageTagMutabilityExclusionFilters*[]ImageTagMutabilityExclusionFilter= undefined - AWS ECR default is n…#These filters specify which image tags can override the repository's default image tag mutability setting.
default
Default: undefined - AWS ECR default is no exclusion filters
lifecycleRegistryIdstringlifecycle_registry_idstrlifecycleRegistryIdStringLifecycleRegistryIdstringLifecycleRegistryId*string= The default registry is assumed.#lifecycleRulesLifecycleRule[]lifecycle_rulestyping.List[LifecycleRule]lifecycleRulesList<LifecycleRule>LifecycleRulesLifecycleRule[]LifecycleRules*[]LifecycleRule= No life cycle rules#removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.Retain#repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*string= Automatically generated name.#notes
The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#ACCOUNT.dkr.ecr.REGION.amazonaws.com
repositoryArnstringrepository_arnstrrepositoryArnStringRepositoryArnstringRepositoryArn*stringrequired#repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*stringrequired#repositoryRefRepositoryReferencerepository_refRepositoryReferencerepositoryRefRepositoryReferenceRepositoryRefRepositoryReferenceRepositoryRefRepositoryReferencerequired#repositoryUristringrepository_uristrrepositoryUriStringRepositoryUristringRepositoryUri*stringrequired#ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY
Methods
addLifecycleRule(rule: LifecycleRule): voiddef add_lifecycle_rule(self, rule: LifecycleRule) -> Nonepublic void addLifecycleRule(LifecycleRule rule)public void AddLifecycleRule(LifecycleRule rule)func AddLifecycleRule(Rule LifecycleRule)#Life cycle rules automatically expire images from the repository that match certain conditions.
addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResultdef add_to_resource_policy(self, statement: PolicyStatement) -> AddToResourcePolicyResultpublic AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)public AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)func AddToResourcePolicy(Statement PolicyStatement) AddToResourcePolicyResult#While other resources policies in AWS either require or accept a resource section, Cfn for ECR does not allow us to specify a resource policy. It will fail if a resource section is present at all.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
arnForLocalRepository(repositoryName: string, scope: IConstruct, account?: string): string@staticmethod def arn_for_local_repository(repository_name: str, scope: IConstruct, account: typing.Optional[str] = None) -> strpublic static String arnForLocalRepository(String repositoryName, IConstruct scope, String account)public static string ArnForLocalRepository(string repositoryName, IConstruct scope, string? account = null)func ArnForLocalRepository(RepositoryName *string, Scope IConstruct, Account *string) *stringstatic#fromLookup(scope: Construct, id: string, options: RepositoryLookupOptions): IRepository@staticmethod def from_lookup(scope: Construct, id: str, options: RepositoryLookupOptions) -> IRepositorypublic static IRepository fromLookup(Construct scope, String id, RepositoryLookupOptions options)public static IRepository FromLookup(Construct scope, string id, RepositoryLookupOptions options)func FromLookup(Scope Construct, Id *string, Options RepositoryLookupOptions) IRepositorystatic#fromRepositoryArn(scope: Construct, id: string, repositoryArn: string): IRepository@staticmethod def from_repository_arn(scope: Construct, id: str, repository_arn: str) -> IRepositorypublic static IRepository fromRepositoryArn(Construct scope, String id, String repositoryArn)public static IRepository FromRepositoryArn(Construct scope, string id, string repositoryArn)func FromRepositoryArn(Scope Construct, Id *string, RepositoryArn *string) IRepositorystatic#fromRepositoryAttributes(scope: Construct, id: string, attrs: RepositoryAttributes): IRepository@staticmethod def from_repository_attributes(scope: Construct, id: str, attrs: RepositoryAttributes) -> IRepositorypublic static IRepository fromRepositoryAttributes(Construct scope, String id, RepositoryAttributes attrs)public static IRepository FromRepositoryAttributes(Construct scope, string id, RepositoryAttributes attrs)func FromRepositoryAttributes(Scope Construct, Id *string, Attrs RepositoryAttributes) IRepositorystatic#fromRepositoryName(scope: Construct, id: string, repositoryName: string): IRepository@staticmethod def from_repository_name(scope: Construct, id: str, repository_name: str) -> IRepositorypublic static IRepository fromRepositoryName(Construct scope, String id, String repositoryName)public static IRepository FromRepositoryName(Construct scope, string id, string repositoryName)func FromRepositoryName(Scope Construct, Id *string, RepositoryName *string) IRepositorystatic#grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#grantPull(grantee: IGrantable): Grantdef grant_pull(self, grantee: IGrantable) -> Grantpublic Grant grantPull(IGrantable grantee)public Grant GrantPull(IGrantable grantee)func GrantPull(Grantee IGrantable) Grant#grantPullPush(grantee: IGrantable): Grantdef grant_pull_push(self, grantee: IGrantable) -> Grantpublic Grant grantPullPush(IGrantable grantee)public Grant GrantPullPush(IGrantable grantee)func GrantPullPush(Grantee IGrantable) Grant#[disable-awslint:no-grants]
grantPush(grantee: IGrantable): Grantdef grant_push(self, grantee: IGrantable) -> Grantpublic Grant grantPush(IGrantable grantee)public Grant GrantPush(IGrantable grantee)func GrantPush(Grantee IGrantable) Grant#grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#onCloudTrailEvent(id: string, options?: OnEventOptions): Ruledef on_cloud_trail_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onCloudTrailEvent(String id, OnEventOptions options)public Rule OnCloudTrailEvent(string id, OnEventOptions? options = null)func OnCloudTrailEvent(Id *string, Options OnEventOptions) Rule#Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
2 parameters
Parameters
ididididId— The id of the rule.optionsoptionsoptionsoptionsOptions— Options for adding the rule.
onCloudTrailImagePushed(id: string, options?: OnCloudTrailImagePushedOptions): Ruledef on_cloud_trail_image_pushed(self, id: str, options: typing.Optional[OnCloudTrailImagePushedOptions] = None) -> Rulepublic Rule onCloudTrailImagePushed(String id, OnCloudTrailImagePushedOptions options)public Rule OnCloudTrailImagePushed(string id, OnCloudTrailImagePushedOptions? options = null)func OnCloudTrailImagePushed(Id *string, Options OnCloudTrailImagePushedOptions) Rule#Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail.
2 parameters
Parameters
ididididId— The id of the rule.optionsoptionsoptionsoptionsOptions— Options for adding the rule.
onEvent(id: string, options?: OnEventOptions): Ruledef on_event(self, id: str, options: typing.Optional[OnEventOptions] = None) -> Rulepublic Rule onEvent(String id, OnEventOptions options)public Rule OnEvent(string id, OnEventOptions? options = null)func OnEvent(Id *string, Options OnEventOptions) Rule#Use rule.addEventPattern(pattern) to specify a filter.
onImageScanCompleted(id: string, options?: OnImageScanCompletedOptions): Ruledef on_image_scan_completed(self, id: str, options: typing.Optional[OnImageScanCompletedOptions] = None) -> Rulepublic Rule onImageScanCompleted(String id, OnImageScanCompletedOptions options)public Rule OnImageScanCompleted(string id, OnImageScanCompletedOptions? options = null)func OnImageScanCompleted(Id *string, Options OnImageScanCompletedOptions) Rule#2 parameters
Parameters
ididididId— The id of the rule.optionsoptionsoptionsoptionsOptions— Options for adding the rule.
repositoryUriForDigest(digest?: string): stringdef repository_uri_for_digest(self, digest: typing.Optional[str] = None) -> strpublic String repositoryUriForDigest(String digest)public string RepositoryUriForDigest(string? digest = null)func RepositoryUriForDigest(Digest *string) *string#ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
1 parameter
Parameters
digestdigestdigestdigestDigest— Optional image digest.
repositoryUriForTag(tag?: string): stringdef repository_uri_for_tag(self, tag: typing.Optional[str] = None) -> strpublic String repositoryUriForTag(String tag)public string RepositoryUriForTag(string? tag = null)func RepositoryUriForTag(Tag *string) *string#ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
1 parameter
Parameters
tagtagtagtagTag— Optional image tag.
repositoryUriForTagOrDigest(tagOrDigest?: string): stringdef repository_uri_for_tag_or_digest(self, tag_or_digest: typing.Optional[str] = None) -> strpublic String repositoryUriForTagOrDigest(String tagOrDigest)public string RepositoryUriForTagOrDigest(string? tagOrDigest = null)func RepositoryUriForTagOrDigest(TagOrDigest *string) *string#ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG] ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]
1 parameter
Parameters
tagOrDigesttag_or_digesttagOrDigesttagOrDigestTagOrDigest— Optional image tag or digest (digests must start withsha256:).
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.