RepositoryBase L2 construct
Base class for ECR repository.
Reused between imported repositories and owned repositories.
Initializer
new RepositoryBase(scope: Construct, id: string, props?: ResourceProps)
RepositoryBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)
new RepositoryBase(Construct scope, String id, ResourceProps props)
new RepositoryBase(Construct scope, string id, ResourceProps? props = null)
NewRepositoryBase(Scope Construct, Id *string, Props ResourceProps)
Construct Props
default
Default: the resource is in the same account as the stack it belongs to
environmentFromArnstringenvironment_from_arnstrenvironmentFromArnStringEnvironmentFromArnstringEnvironmentFromArn*string= take environment from `account`,…#The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.
Cannot be supplied together with either account or region.
default
Default: take environment from account, region parameters, or use Stack environment.
physicalNamestringphysical_namestrphysicalNameStringPhysicalNamestringPhysicalName*string= The physical name will be alloca…#notes · default
undefinedimplies that a physical name will be allocated by CloudFormation during deployment.- a concrete value implies a specific physical name
PhysicalName.GENERATE_IF_NEEDEDis a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
Default: The physical name will be allocated by CloudFormation at deployment time
default
Default: the resource is in the same region as the stack it belongs to
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.
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
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#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).
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.