Skip to content

Instantly share code, notes, and snippets.

@Chriscbr

Chriscbr/ecr-python.json Secret

Last active January 18, 2022 07:43
Show Gist options
  • Save Chriscbr/731b315808faaf2a2161d686ce248368 to your computer and use it in GitHub Desktop.
Save Chriscbr/731b315808faaf2a2161d686ce248368 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
ecr-python.json
{
"version": "0.1",
"language": "python",
"metadata": {
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
},
"readme": "# Amazon ECR Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n<!--END STABILITY BANNER-->\n\nThis package contains constructs for working with Amazon Elastic Container Registry.\n\n## Repositories\n\nDefine a repository by creating a new instance of `Repository`. A repository\nholds multiple verions of a single container image.\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\nrepository = ecr.Repository(self, \"Repository\")\n```\n\n## Image scanning\n\nAmazon ECR image scanning helps in identifying software vulnerabilities in your container images. You can manually scan container images stored in Amazon ECR, or you can configure your repositories to scan images when you push them to a repository. To create a new repository to scan on push, simply enable `imageScanOnPush` in the properties\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\nrepository = ecr.Repository(stack, \"Repo\",\n image_scan_on_push=True\n)\n```\n\nTo create an `onImageScanCompleted` event rule and trigger the event target\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\nrepository.on_image_scan_completed(\"ImageScanComplete\").add_target(...)\n```\n\n### Authorization Token\n\nBesides the Amazon ECR APIs, ECR also allows the Docker CLI or a language-specific Docker library to push and pull\nimages from an ECR repository. However, the Docker CLI does not support native IAM authentication methods and\nadditional steps must be taken so that Amazon ECR can authenticate and authorize Docker push and pull requests.\nMore information can be found at at [Registry Authentication](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth).\n\nA Docker authorization token can be obtained using the `GetAuthorizationToken` ECR API. The following code snippets\ngrants an IAM user access to call this API.\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\nimport aws_cdk.aws_iam as iam\nimport aws_cdk.aws_ecr as ecr\n\nuser = iam.User(self, \"User\", ...)\necr.AuthorizationToken.grant_read(user)\n```\n\nIf you access images in the [Public ECR Gallery](https://gallery.ecr.aws/) as well, it is recommended you authenticate to the registry to benefit from\nhigher rate and bandwidth limits.\n\n> See `Pricing` in https://aws.amazon.com/blogs/aws/amazon-ecr-public-a-new-public-container-registry/ and [Service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html).\n\nThe following code snippet grants an IAM user access to retrieve an authorization token for the public gallery.\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\nimport aws_cdk.aws_iam as iam\nimport aws_cdk.aws_ecr as ecr\n\nuser = iam.User(self, \"User\", ...)\necr.PublicGalleryAuthorizationToken.grant_read(user)\n```\n\nThis user can then proceed to login to the registry using one of the [authentication methods](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth).\n\n### Image tag immutability\n\nYou can set tag immutability on images in our repository using the `imageTagMutability` construct prop.\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\necr.Repository(stack, \"Repo\", image_tag_mutability=ecr.TagMutability.IMMUTABLE)\n```\n\n## Automatically clean up repositories\n\nYou can set life cycle rules to automatically clean up old images from your\nrepository. The first life cycle rule that matches an image will be applied\nagainst that image. For example, the following deletes images older than\n30 days, while keeping all images tagged with prod (note that the order\nis important here):\n\n```python\n# Example automatically generated from non-compiling source. May contain errors.\nrepository.add_lifecycle_rule(tag_prefix_list=[\"prod\"], max_image_count=9999)\nrepository.add_lifecycle_rule(max_image_age=cdk.Duration.days(30))\n```",
"apiReference": {
"constructs": [
{
"initializer": {
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer",
"displayName": "Initializer",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.Construct",
"displayName": "Construct",
"fqn": "aws_cdk.core.Construct",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- scope in which this resource is defined."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "- scoped id of the resource."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_catalog_data",
"displayName": "repository_catalog_data",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryCatalogData",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryCatalogData`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryName",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryName`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.repository_policy_text",
"displayName": "repository_policy_text",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.repositoryPolicyText",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryPolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.Initializer.parameter.tags",
"displayName": "tags",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.Initializer.parameter.tags",
"optional": true,
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.CfnTag",
"displayName": "CfnTag",
"fqn": "aws_cdk.core.CfnTag",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.Tags`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags"
]
}
}
],
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnPublicRepository(\n scope: Construct,\n id: str,\n repository_catalog_data: typing.Any = None,\n repository_name: str = None,\n repository_policy_text: typing.Any = None,\n tags: typing.List[CfnTag] = None\n)"
},
"interfaces": [
{
"fqn": "aws_cdk.core.IInspectable",
"displayName": "IInspectable",
"id": "@aws-cdk/core.IInspectable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
],
"instanceMethods": [
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.inspect",
"displayName": "inspect",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.inspect.parameter.inspector",
"displayName": "inspector",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.inspect.parameter.inspector",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.TreeInspector",
"displayName": "TreeInspector",
"fqn": "aws_cdk.core.TreeInspector",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- tree inspector to collect and process attributes."
}
}
],
"docs": {
"summary": "Examines the CloudFormation resource and discloses attributes."
},
"usage": "def inspect(\n inspector: TreeInspector\n)"
}
],
"staticMethods": [],
"constants": [
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.CFN_RESOURCE_TYPE_NAME",
"displayName": "CFN_RESOURCE_TYPE_NAME",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.CFN_RESOURCE_TYPE_NAME",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The CloudFormation resource type name for this resource class."
},
"usage": "CFN_RESOURCE_TYPE_NAME: str",
"const": true
}
],
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.attr_arn",
"displayName": "attr_arn",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.attrArn",
"type": {
"formattingPattern": "str"
},
"docs": {},
"usage": "attr_arn: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.tags",
"displayName": "tags",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.tags",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.TagManager",
"displayName": "TagManager",
"fqn": "aws_cdk.core.TagManager",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.Tags`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags"
]
},
"usage": "tags: TagManager"
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.repository_catalog_data",
"displayName": "repository_catalog_data",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.repositoryCatalogData",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryCatalogData`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata"
]
},
"usage": "repository_catalog_data: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.repository_policy_text",
"displayName": "repository_policy_text",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.repositoryPolicyText",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryPolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext"
]
},
"usage": "repository_policy_text: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository.property.repositoryName",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryName`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname"
]
},
"usage": "repository_name: str"
}
],
"fqn": "aws_cdk.aws_ecr.CfnPublicRepository",
"displayName": "CfnPublicRepository",
"id": "@aws-cdk/aws-ecr.CfnPublicRepository",
"docs": {
"summary": "A CloudFormation `AWS::ECR::PublicRepository`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html"
]
}
},
{
"initializer": {
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer",
"displayName": "Initializer",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.Construct",
"displayName": "Construct",
"fqn": "aws_cdk.core.Construct",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- scope in which this resource is defined."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "- scoped id of the resource."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.Initializer.parameter.policy_text",
"displayName": "policy_text",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.Initializer.parameter.policyText",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::RegistryPolicy.PolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext"
]
}
}
],
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnRegistryPolicy(\n scope: Construct,\n id: str,\n policy_text: typing.Any\n)"
},
"interfaces": [
{
"fqn": "aws_cdk.core.IInspectable",
"displayName": "IInspectable",
"id": "@aws-cdk/core.IInspectable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
],
"instanceMethods": [
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.inspect",
"displayName": "inspect",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.inspect",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.inspect.parameter.inspector",
"displayName": "inspector",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.inspect.parameter.inspector",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.TreeInspector",
"displayName": "TreeInspector",
"fqn": "aws_cdk.core.TreeInspector",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- tree inspector to collect and process attributes."
}
}
],
"docs": {
"summary": "Examines the CloudFormation resource and discloses attributes."
},
"usage": "def inspect(\n inspector: TreeInspector\n)"
}
],
"staticMethods": [],
"constants": [
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.property.CFN_RESOURCE_TYPE_NAME",
"displayName": "CFN_RESOURCE_TYPE_NAME",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.property.CFN_RESOURCE_TYPE_NAME",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The CloudFormation resource type name for this resource class."
},
"usage": "CFN_RESOURCE_TYPE_NAME: str",
"const": true
}
],
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.property.attr_registry_id",
"displayName": "attr_registry_id",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.property.attrRegistryId",
"type": {
"formattingPattern": "str"
},
"docs": {},
"usage": "attr_registry_id: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy.property.policy_text",
"displayName": "policy_text",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy.property.policyText",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::RegistryPolicy.PolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext"
]
},
"usage": "policy_text: typing.Any"
}
],
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicy",
"displayName": "CfnRegistryPolicy",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicy",
"docs": {
"summary": "A CloudFormation `AWS::ECR::RegistryPolicy`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html"
]
}
},
{
"initializer": {
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer",
"displayName": "Initializer",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.Construct",
"displayName": "Construct",
"fqn": "aws_cdk.core.Construct",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- scope in which this resource is defined."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "- scoped id of the resource."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.Initializer.parameter.replication_configuration",
"displayName": "replication_configuration",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.Initializer.parameter.replicationConfiguration",
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"displayName": "ReplicationConfigurationProperty",
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration"
]
}
}
],
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnReplicationConfiguration(\n scope: Construct,\n id: str,\n replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty]\n)"
},
"interfaces": [
{
"fqn": "aws_cdk.core.IInspectable",
"displayName": "IInspectable",
"id": "@aws-cdk/core.IInspectable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
],
"instanceMethods": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.inspect",
"displayName": "inspect",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.inspect",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.inspect.parameter.inspector",
"displayName": "inspector",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.inspect.parameter.inspector",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.TreeInspector",
"displayName": "TreeInspector",
"fqn": "aws_cdk.core.TreeInspector",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- tree inspector to collect and process attributes."
}
}
],
"docs": {
"summary": "Examines the CloudFormation resource and discloses attributes."
},
"usage": "def inspect(\n inspector: TreeInspector\n)"
}
],
"staticMethods": [],
"constants": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.property.CFN_RESOURCE_TYPE_NAME",
"displayName": "CFN_RESOURCE_TYPE_NAME",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.property.CFN_RESOURCE_TYPE_NAME",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The CloudFormation resource type name for this resource class."
},
"usage": "CFN_RESOURCE_TYPE_NAME: str",
"const": true
}
],
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.property.attr_registry_id",
"displayName": "attr_registry_id",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.property.attrRegistryId",
"type": {
"formattingPattern": "str"
},
"docs": {},
"usage": "attr_registry_id: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.property.replication_configuration",
"displayName": "replication_configuration",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.property.replicationConfiguration",
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"displayName": "ReplicationConfigurationProperty",
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration"
]
},
"usage": "replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty]"
}
],
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration",
"displayName": "CfnReplicationConfiguration",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration",
"docs": {
"summary": "A CloudFormation `AWS::ECR::ReplicationConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html"
]
}
},
{
"initializer": {
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer",
"displayName": "Initializer",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.Construct",
"displayName": "Construct",
"fqn": "aws_cdk.core.Construct",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- scope in which this resource is defined."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "- scoped id of the resource."
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.encryption_configuration",
"displayName": "encryption_configuration",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.encryptionConfiguration",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.EncryptionConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.image_scanning_configuration",
"displayName": "image_scanning_configuration",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.imageScanningConfiguration",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.ImageScanningConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.image_tag_mutability",
"displayName": "image_tag_mutability",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.imageTagMutability",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::Repository.ImageTagMutability`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.lifecycle_policy",
"displayName": "lifecycle_policy",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.lifecyclePolicy",
"optional": true,
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty",
"displayName": "LifecyclePolicyProperty",
"fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::Repository.LifecyclePolicy`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.repositoryName",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::Repository.RepositoryName`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.repository_policy_text",
"displayName": "repository_policy_text",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.repositoryPolicyText",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.RepositoryPolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.Initializer.parameter.tags",
"displayName": "tags",
"id": "@aws-cdk/aws-ecr.CfnRepository.Initializer.parameter.tags",
"optional": true,
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.CfnTag",
"displayName": "CfnTag",
"fqn": "aws_cdk.core.CfnTag",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::Repository.Tags`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags"
]
}
}
],
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnRepository(\n scope: Construct,\n id: str,\n encryption_configuration: typing.Any = None,\n image_scanning_configuration: typing.Any = None,\n image_tag_mutability: str = None,\n lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None,\n repository_name: str = None,\n repository_policy_text: typing.Any = None,\n tags: typing.List[CfnTag] = None\n)"
},
"interfaces": [
{
"fqn": "aws_cdk.core.IInspectable",
"displayName": "IInspectable",
"id": "@aws-cdk/core.IInspectable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
],
"instanceMethods": [
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.inspect",
"displayName": "inspect",
"id": "@aws-cdk/aws-ecr.CfnRepository.inspect",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.inspect.parameter.inspector",
"displayName": "inspector",
"id": "@aws-cdk/aws-ecr.CfnRepository.inspect.parameter.inspector",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.TreeInspector",
"displayName": "TreeInspector",
"fqn": "aws_cdk.core.TreeInspector",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "- tree inspector to collect and process attributes."
}
}
],
"docs": {
"summary": "Examines the CloudFormation resource and discloses attributes."
},
"usage": "def inspect(\n inspector: TreeInspector\n)"
}
],
"staticMethods": [],
"constants": [
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.CFN_RESOURCE_TYPE_NAME",
"displayName": "CFN_RESOURCE_TYPE_NAME",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.CFN_RESOURCE_TYPE_NAME",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The CloudFormation resource type name for this resource class."
},
"usage": "CFN_RESOURCE_TYPE_NAME: str",
"const": true
}
],
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.attr_arn",
"displayName": "attr_arn",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.attrArn",
"type": {
"formattingPattern": "str"
},
"docs": {},
"usage": "attr_arn: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.attr_repository_uri",
"displayName": "attr_repository_uri",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.attrRepositoryUri",
"type": {
"formattingPattern": "str"
},
"docs": {},
"usage": "attr_repository_uri: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.tags",
"displayName": "tags",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.tags",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.TagManager",
"displayName": "TagManager",
"fqn": "aws_cdk.core.TagManager",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "`AWS::ECR::Repository.Tags`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags"
]
},
"usage": "tags: TagManager"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.encryption_configuration",
"displayName": "encryption_configuration",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.encryptionConfiguration",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.EncryptionConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration"
]
},
"usage": "encryption_configuration: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.image_scanning_configuration",
"displayName": "image_scanning_configuration",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.imageScanningConfiguration",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.ImageScanningConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration"
]
},
"usage": "image_scanning_configuration: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.repository_policy_text",
"displayName": "repository_policy_text",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.repositoryPolicyText",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.RepositoryPolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext"
]
},
"usage": "repository_policy_text: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.image_tag_mutability",
"displayName": "image_tag_mutability",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.imageTagMutability",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::Repository.ImageTagMutability`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability"
]
},
"usage": "image_tag_mutability: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.lifecycle_policy",
"displayName": "lifecycle_policy",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.lifecyclePolicy",
"optional": true,
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty",
"displayName": "LifecyclePolicyProperty",
"fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::Repository.LifecyclePolicy`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy"
]
},
"usage": "lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty]"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.CfnRepository.property.repositoryName",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::Repository.RepositoryName`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname"
]
},
"usage": "repository_name: str"
}
],
"fqn": "aws_cdk.aws_ecr.CfnRepository",
"displayName": "CfnRepository",
"id": "@aws-cdk/aws-ecr.CfnRepository",
"docs": {
"summary": "A CloudFormation `AWS::ECR::Repository`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html"
]
}
},
{
"initializer": {
"fqn": "aws_cdk.aws_ecr.Repository.Initializer",
"displayName": "Initializer",
"id": "@aws-cdk/aws-ecr.Repository.Initializer",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "constructs.Construct",
"displayName": "Construct",
"fqn": "constructs.Construct",
"packageName": "constructs",
"packageVersion": "3.3.192"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.image_scan_on_push",
"displayName": "image_scan_on_push",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.imageScanOnPush",
"optional": true,
"default": "false",
"type": {
"formattingPattern": "bool"
},
"docs": {
"summary": "Enable the scan on push when creating the repository."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.image_tag_mutability",
"displayName": "image_tag_mutability",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.imageTagMutability",
"optional": true,
"default": "TagMutability.MUTABLE",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.TagMutability",
"displayName": "TagMutability",
"fqn": "aws_cdk.aws_ecr.TagMutability",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The tag mutability setting for the repository.",
"remarks": "If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.lifecycle_registry_id",
"displayName": "lifecycle_registry_id",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.lifecycleRegistryId",
"optional": true,
"default": "The default registry is assumed.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The AWS account ID associated with the registry that contains the repository.",
"links": [
"https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.lifecycle_rules",
"displayName": "lifecycle_rules",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.lifecycleRules",
"optional": true,
"default": "No life cycle rules",
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.LifecycleRule",
"displayName": "LifecycleRule",
"fqn": "aws_cdk.aws_ecr.LifecycleRule",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "Life cycle rules to apply to this registry."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.removal_policy",
"displayName": "removal_policy",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.removalPolicy",
"optional": true,
"default": "RemovalPolicy.Retain",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.RemovalPolicy",
"displayName": "RemovalPolicy",
"fqn": "aws_cdk.core.RemovalPolicy",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Determine what happens to the repository when the resource/stack is deleted."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.Initializer.parameter.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.Repository.Initializer.parameter.repositoryName",
"optional": true,
"default": "Automatically generated name.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Name for this repository."
}
}
],
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.Repository(\n scope: Construct,\n id: str,\n image_scan_on_push: bool = None,\n image_tag_mutability: TagMutability = None,\n lifecycle_registry_id: str = None,\n lifecycle_rules: typing.List[LifecycleRule] = None,\n removal_policy: RemovalPolicy = None,\n repository_name: str = None\n)"
},
"interfaces": [],
"instanceMethods": [
{
"fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule",
"displayName": "add_lifecycle_rule",
"id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.description",
"optional": true,
"default": "No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Describes the purpose of the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.max_image_age",
"displayName": "max_image_age",
"id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.maxImageAge",
"optional": true,
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.Duration",
"displayName": "Duration",
"fqn": "aws_cdk.core.Duration",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The maximum age of images to retain. The value must represent a number of days.",
"remarks": "Specify exactly one of maxImageCount and maxImageAge."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.max_image_count",
"displayName": "max_image_count",
"id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.maxImageCount",
"optional": true,
"type": {
"formattingPattern": "typing.Union[int, float]"
},
"docs": {
"summary": "The maximum number of images to retain.",
"remarks": "Specify exactly one of maxImageCount and maxImageAge."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.rule_priority",
"displayName": "rule_priority",
"id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.rulePriority",
"optional": true,
"default": "Automatically assigned",
"type": {
"formattingPattern": "typing.Union[int, float]"
},
"docs": {
"summary": "Controls the order in which rules are evaluated (low to high).",
"remarks": "All rules must have a unique priority, where lower numbers have\nhigher precedence. The first rule that matches is applied to an image.\n\nThere can only be one rule with a tagStatus of Any, and it must have\nthe highest rulePriority.\n\nAll rules without a specified priority will have incrementing priorities\nautomatically assigned to them, higher than any rules that DO have priorities."
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.tag_prefix_list",
"displayName": "tag_prefix_list",
"id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.tagPrefixList",
"optional": true,
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "str"
}
]
},
"docs": {
"summary": "Select images that have ALL the given prefixes in their tag.",
"remarks": "Only if tagStatus == TagStatus.Tagged"
}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.add_lifecycle_rule.parameter.tag_status",
"displayName": "tag_status",
"id": "@aws-cdk/aws-ecr.Repository.addLifecycleRule.parameter.tagStatus",
"optional": true,
"default": "TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.TagStatus",
"displayName": "TagStatus",
"fqn": "aws_cdk.aws_ecr.TagStatus",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Select images based on tags.",
"remarks": "Only one rule is allowed to select untagged images, and it must\nhave the highest rulePriority."
}
}
],
"docs": {
"summary": "Add a life cycle rule to the repository.",
"remarks": "Life cycle rules automatically expire images from the repository that match\ncertain conditions."
},
"usage": "def add_lifecycle_rule(\n description: str = None,\n max_image_age: Duration = None,\n max_image_count: typing.Union[int, float] = None,\n rule_priority: typing.Union[int, float] = None,\n tag_prefix_list: typing.List[str] = None,\n tag_status: TagStatus = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.Repository.add_to_resource_policy",
"displayName": "add_to_resource_policy",
"id": "@aws-cdk/aws-ecr.Repository.addToResourcePolicy",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.Repository.add_to_resource_policy.parameter.statement",
"displayName": "statement",
"id": "@aws-cdk/aws-ecr.Repository.addToResourcePolicy.parameter.statement",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.PolicyStatement",
"displayName": "PolicyStatement",
"fqn": "aws_cdk.aws_iam.PolicyStatement",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Add a policy statement to the repository's resource policy."
},
"usage": "def add_to_resource_policy(\n statement: PolicyStatement\n)"
}
],
"staticMethods": [
{
"fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository",
"displayName": "arn_for_local_repository",
"id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository.parameter.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository.parameter.repositoryName",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "constructs.IConstruct",
"displayName": "IConstruct",
"fqn": "constructs.IConstruct",
"packageName": "constructs",
"packageVersion": "3.3.192"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.arn_for_local_repository.parameter.account",
"displayName": "account",
"id": "@aws-cdk/aws-ecr.Repository.arnForLocalRepository.parameter.account",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {}
}
],
"docs": {
"summary": "Returns an ECR ARN for a repository that resides in the same account/region as the current stack."
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.Repository.arn_for_local_repository(\n repository_name: str,\n scope: IConstruct,\n account: str = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn",
"displayName": "from_repository_arn",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "constructs.Construct",
"displayName": "Construct",
"fqn": "constructs.Construct",
"packageName": "constructs",
"packageVersion": "3.3.192"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_arn.parameter.repository_arn",
"displayName": "repository_arn",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryArn.parameter.repositoryArn",
"type": {
"formattingPattern": "str"
},
"docs": {}
}
],
"docs": {},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.Repository.from_repository_arn(\n scope: Construct,\n id: str,\n repository_arn: str\n)"
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes",
"displayName": "from_repository_attributes",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "constructs.Construct",
"displayName": "Construct",
"fqn": "constructs.Construct",
"packageName": "constructs",
"packageVersion": "3.3.192"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.repository_arn",
"displayName": "repository_arn",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.repositoryArn",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_attributes.parameter.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryAttributes.parameter.repositoryName",
"type": {
"formattingPattern": "str"
},
"docs": {}
}
],
"docs": {
"summary": "Import a repository."
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.Repository.from_repository_attributes(\n scope: Construct,\n id: str,\n repository_arn: str,\n repository_name: str\n)"
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_name",
"displayName": "from_repository_name",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_name.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "constructs.Construct",
"displayName": "Construct",
"fqn": "constructs.Construct",
"packageName": "constructs",
"packageVersion": "3.3.192"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_name.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.Repository.from_repository_name.parameter.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.Repository.fromRepositoryName.parameter.repositoryName",
"type": {
"formattingPattern": "str"
},
"docs": {}
}
],
"docs": {},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.Repository.from_repository_name(\n scope: Construct,\n id: str,\n repository_name: str\n)"
}
],
"constants": [],
"properties": [
{
"fqn": "aws_cdk.aws_ecr.Repository.property.repository_arn",
"displayName": "repository_arn",
"id": "@aws-cdk/aws-ecr.Repository.property.repositoryArn",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The ARN of the repository."
},
"usage": "repository_arn: str"
},
{
"fqn": "aws_cdk.aws_ecr.Repository.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.Repository.property.repositoryName",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The name of the repository."
},
"usage": "repository_name: str"
}
],
"fqn": "aws_cdk.aws_ecr.Repository",
"displayName": "Repository",
"id": "@aws-cdk/aws-ecr.Repository",
"docs": {
"summary": "Define an ECR repository."
}
},
{
"initializer": {
"fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer",
"displayName": "Initializer",
"id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.scope",
"displayName": "scope",
"id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.scope",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "constructs.Construct",
"displayName": "Construct",
"fqn": "constructs.Construct",
"packageName": "constructs",
"packageVersion": "3.3.192"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.account",
"displayName": "account",
"id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.account",
"optional": true,
"default": "- the resource is in the same account as the stack it belongs to",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The AWS account ID this resource belongs to."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.environment_from_arn",
"displayName": "environment_from_arn",
"id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.environmentFromArn",
"optional": true,
"default": "- take environment from `account`, `region` parameters, or use Stack environment.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "ARN to deduce region and account from.",
"remarks": "The ARN is parsed and the account and region are taken from the ARN.\nThis should be used for imported resources.\n\nCannot be supplied together with either `account` or `region`."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.physical_name",
"displayName": "physical_name",
"id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.physicalName",
"optional": true,
"default": "- The physical name will be allocated by CloudFormation at deployment time",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The value passed in by users to the physical name prop of the resource.",
"remarks": "- `undefined` implies that a physical name will be allocated by\n CloudFormation during deployment.\n- a concrete value implies a specific physical name\n- `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated\n by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.Initializer.parameter.region",
"displayName": "region",
"id": "@aws-cdk/aws-ecr.RepositoryBase.Initializer.parameter.region",
"optional": true,
"default": "- the resource is in the same region as the stack it belongs to",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The AWS region this resource belongs to."
}
}
],
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.RepositoryBase(\n scope: Construct,\n id: str,\n account: str = None,\n environment_from_arn: str = None,\n physical_name: str = None,\n region: str = None\n)"
},
"interfaces": [
{
"fqn": "aws_cdk.aws_ecr.IRepository",
"displayName": "IRepository",
"id": "@aws-cdk/aws-ecr.IRepository",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
],
"instanceMethods": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.add_to_resource_policy",
"displayName": "add_to_resource_policy",
"id": "@aws-cdk/aws-ecr.RepositoryBase.addToResourcePolicy",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.add_to_resource_policy.parameter.statement",
"displayName": "statement",
"id": "@aws-cdk/aws-ecr.RepositoryBase.addToResourcePolicy.parameter.statement",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.PolicyStatement",
"displayName": "PolicyStatement",
"fqn": "aws_cdk.aws_iam.PolicyStatement",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Add a policy statement to the repository's resource policy."
},
"usage": "def add_to_resource_policy(\n statement: PolicyStatement\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.grant",
"displayName": "grant",
"id": "@aws-cdk/aws-ecr.RepositoryBase.grant",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.grant.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.RepositoryBase.grant.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.grant.parameter.actions",
"displayName": "actions",
"id": "@aws-cdk/aws-ecr.RepositoryBase.grant.parameter.actions",
"type": {
"formattingPattern": "str"
},
"docs": {}
}
],
"docs": {
"summary": "Grant the given principal identity permissions to perform the actions on this repository."
},
"usage": "def grant(\n grantee: IGrantable,\n actions: str\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull",
"displayName": "grant_pull",
"id": "@aws-cdk/aws-ecr.RepositoryBase.grantPull",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.RepositoryBase.grantPull.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Grant the given identity permissions to use the images in this repository."
},
"usage": "def grant_pull(\n grantee: IGrantable\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull_push",
"displayName": "grant_pull_push",
"id": "@aws-cdk/aws-ecr.RepositoryBase.grantPullPush",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.grant_pull_push.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.RepositoryBase.grantPullPush.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Grant the given identity permissions to pull and push images to this repository."
},
"usage": "def grant_pull_push(\n grantee: IGrantable\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event",
"displayName": "on_cloud_trail_event",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The id of the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_event.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailEvent.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
}
],
"docs": {
"summary": "Define a CloudWatch event that triggers when something happens to this repository.",
"remarks": "Requires that there exists at least one CloudTrail Trail in your account\nthat captures the event. This method will not create the Trail."
},
"usage": "def on_cloud_trail_event(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed",
"displayName": "on_cloud_trail_image_pushed",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The id of the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_cloud_trail_image_pushed.parameter.image_tag",
"displayName": "image_tag",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onCloudTrailImagePushed.parameter.imageTag",
"optional": true,
"default": "- Watch changes to all tags",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Only watch changes to this image tag."
}
}
],
"docs": {
"summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.",
"remarks": "Requires that there exists at least one CloudTrail Trail in your account\nthat captures the event. This method will not create the Trail."
},
"usage": "def on_cloud_trail_image_pushed(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None,\n image_tag: str = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event",
"displayName": "on_event",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_event.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onEvent.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
}
],
"docs": {
"summary": "Defines a CloudWatch event rule which triggers for repository events.",
"remarks": "Use\n`rule.addEventPattern(pattern)` to specify a filter."
},
"usage": "def on_event(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed",
"displayName": "on_image_scan_completed",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The id of the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.on_image_scan_completed.parameter.image_tags",
"displayName": "image_tags",
"id": "@aws-cdk/aws-ecr.RepositoryBase.onImageScanCompleted.parameter.imageTags",
"optional": true,
"default": "- Watch the changes to the repository with all image tags",
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "str"
}
]
},
"docs": {
"summary": "Only watch changes to the image tags spedified.",
"remarks": "Leave it undefined to watch the full repository."
}
}
],
"docs": {
"summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image scan is completed."
},
"usage": "def on_image_scan_completed(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None,\n image_tags: typing.List[str] = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_digest",
"displayName": "repository_uri_for_digest",
"id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForDigest",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_digest.parameter.digest",
"displayName": "digest",
"id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForDigest.parameter.digest",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Optional image digest."
}
}
],
"docs": {
"summary": "Returns the URL of the repository. Can be used in `docker push/pull`.",
"remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]"
},
"usage": "def repository_uri_for_digest(\n digest: str = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_tag",
"displayName": "repository_uri_for_tag",
"id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForTag",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.repository_uri_for_tag.parameter.tag",
"displayName": "tag",
"id": "@aws-cdk/aws-ecr.RepositoryBase.repositoryUriForTag.parameter.tag",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Optional image tag."
}
}
],
"docs": {
"summary": "Returns the URL of the repository. Can be used in `docker push/pull`.",
"remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]"
},
"usage": "def repository_uri_for_tag(\n tag: str = None\n)"
}
],
"staticMethods": [],
"constants": [],
"properties": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.property.repository_arn",
"displayName": "repository_arn",
"id": "@aws-cdk/aws-ecr.RepositoryBase.property.repositoryArn",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The ARN of the repository."
},
"usage": "repository_arn: str"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.RepositoryBase.property.repositoryName",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The name of the repository."
},
"usage": "repository_name: str"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase.property.repository_uri",
"displayName": "repository_uri",
"id": "@aws-cdk/aws-ecr.RepositoryBase.property.repositoryUri",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The URI of this repository (represents the latest image):.",
"remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY"
},
"usage": "repository_uri: str"
}
],
"fqn": "aws_cdk.aws_ecr.RepositoryBase",
"displayName": "RepositoryBase",
"id": "@aws-cdk/aws-ecr.RepositoryBase",
"docs": {
"summary": "Base class for ECR repository.",
"remarks": "Reused between imported repositories and owned repositories."
}
}
],
"classes": [
{
"interfaces": [],
"instanceMethods": [],
"staticMethods": [
{
"fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read",
"displayName": "grant_read",
"id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.AuthorizationToken.grant_read.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.AuthorizationToken.grantRead.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Grant access to retrieve an authorization token."
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.AuthorizationToken.grant_read(\n grantee: IGrantable\n)"
}
],
"constants": [],
"properties": [],
"fqn": "aws_cdk.aws_ecr.AuthorizationToken",
"displayName": "AuthorizationToken",
"id": "@aws-cdk/aws-ecr.AuthorizationToken",
"docs": {
"summary": "Authorization token to access private ECR repositories in the current environment via Docker CLI.",
"links": [
"https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html"
]
}
},
{
"interfaces": [],
"instanceMethods": [],
"staticMethods": [
{
"fqn": "aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read",
"displayName": "grant_read",
"id": "@aws-cdk/aws-ecr.PublicGalleryAuthorizationToken.grantRead",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.PublicGalleryAuthorizationToken.grantRead.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Grant access to retrieve an authorization token."
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.PublicGalleryAuthorizationToken.grant_read(\n grantee: IGrantable\n)"
}
],
"constants": [],
"properties": [],
"fqn": "aws_cdk.aws_ecr.PublicGalleryAuthorizationToken",
"displayName": "PublicGalleryAuthorizationToken",
"id": "@aws-cdk/aws-ecr.PublicGalleryAuthorizationToken",
"docs": {
"summary": "Authorization token to access the global public ECR Gallery via Docker CLI.",
"links": [
"https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth"
]
}
}
],
"structs": [
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps",
"displayName": "CfnPublicRepositoryProps",
"id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_catalog_data",
"displayName": "repository_catalog_data",
"id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryCatalogData",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryCatalogData`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorycatalogdata"
]
},
"usage": "repository_catalog_data: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryName",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryName`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositoryname"
]
},
"usage": "repository_name: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.repository_policy_text",
"displayName": "repository_policy_text",
"id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.repositoryPolicyText",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.RepositoryPolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-repositorypolicytext"
]
},
"usage": "repository_policy_text: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnPublicRepositoryProps.property.tags",
"displayName": "tags",
"id": "@aws-cdk/aws-ecr.CfnPublicRepositoryProps.property.tags",
"optional": true,
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.CfnTag",
"displayName": "CfnTag",
"fqn": "aws_cdk.core.CfnTag",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::PublicRepository.Tags`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html#cfn-ecr-publicrepository-tags"
]
},
"usage": "tags: typing.List[CfnTag]"
}
],
"docs": {
"summary": "Properties for defining a `AWS::ECR::PublicRepository`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-publicrepository.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnPublicRepositoryProps(\n repository_catalog_data: typing.Any = None,\n repository_name: str = None,\n repository_policy_text: typing.Any = None,\n tags: typing.List[CfnTag] = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicyProps",
"displayName": "CfnRegistryPolicyProps",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicyProps",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnRegistryPolicyProps.property.policy_text",
"displayName": "policy_text",
"id": "@aws-cdk/aws-ecr.CfnRegistryPolicyProps.property.policyText",
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::RegistryPolicy.PolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html#cfn-ecr-registrypolicy-policytext"
]
},
"usage": "policy_text: typing.Any"
}
],
"docs": {
"summary": "Properties for defining a `AWS::ECR::RegistryPolicy`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-registrypolicy.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnRegistryPolicyProps(\n policy_text: typing.Any\n)"
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfigurationProps",
"displayName": "CfnReplicationConfigurationProps",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfigurationProps",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfigurationProps.property.replication_configuration",
"displayName": "replication_configuration",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfigurationProps.property.replicationConfiguration",
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"displayName": "ReplicationConfigurationProperty",
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::ReplicationConfiguration.ReplicationConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration"
]
},
"usage": "replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty]"
}
],
"docs": {
"summary": "Properties for defining a `AWS::ECR::ReplicationConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-replicationconfiguration.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnReplicationConfigurationProps(\n replication_configuration: typing.Union[IResolvable, ReplicationConfigurationProperty]\n)"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps",
"displayName": "CfnRepositoryProps",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.encryption_configuration",
"displayName": "encryption_configuration",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.encryptionConfiguration",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.EncryptionConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-encryptionconfiguration"
]
},
"usage": "encryption_configuration: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.image_scanning_configuration",
"displayName": "image_scanning_configuration",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.imageScanningConfiguration",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.ImageScanningConfiguration`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagescanningconfiguration"
]
},
"usage": "image_scanning_configuration: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.image_tag_mutability",
"displayName": "image_tag_mutability",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.imageTagMutability",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::Repository.ImageTagMutability`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-imagetagmutability"
]
},
"usage": "image_tag_mutability: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.lifecycle_policy",
"displayName": "lifecycle_policy",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.lifecyclePolicy",
"optional": true,
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty",
"displayName": "LifecyclePolicyProperty",
"fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::Repository.LifecyclePolicy`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-lifecyclepolicy"
]
},
"usage": "lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty]"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.repositoryName",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`AWS::ECR::Repository.RepositoryName`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositoryname"
]
},
"usage": "repository_name: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.repository_policy_text",
"displayName": "repository_policy_text",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.repositoryPolicyText",
"optional": true,
"type": {
"formattingPattern": "typing.Any"
},
"docs": {
"summary": "`AWS::ECR::Repository.RepositoryPolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-repositorypolicytext"
]
},
"usage": "repository_policy_text: typing.Any"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepositoryProps.property.tags",
"displayName": "tags",
"id": "@aws-cdk/aws-ecr.CfnRepositoryProps.property.tags",
"optional": true,
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.CfnTag",
"displayName": "CfnTag",
"fqn": "aws_cdk.core.CfnTag",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "`AWS::ECR::Repository.Tags`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html#cfn-ecr-repository-tags"
]
},
"usage": "tags: typing.List[CfnTag]"
}
],
"docs": {
"summary": "Properties for defining a `AWS::ECR::Repository`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecr-repository.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnRepositoryProps(\n encryption_configuration: typing.Any = None,\n image_scanning_configuration: typing.Any = None,\n image_tag_mutability: str = None,\n lifecycle_policy: typing.Union[IResolvable, LifecyclePolicyProperty] = None,\n repository_name: str = None,\n repository_policy_text: typing.Any = None,\n tags: typing.List[CfnTag] = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty",
"displayName": "LifecyclePolicyProperty",
"id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty.property.lifecycle_policy_text",
"displayName": "lifecycle_policy_text",
"id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty.property.lifecyclePolicyText",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`CfnRepository.LifecyclePolicyProperty.LifecyclePolicyText`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-lifecyclepolicytext"
]
},
"usage": "lifecycle_policy_text: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty.property.registry_id",
"displayName": "registry_id",
"id": "@aws-cdk/aws-ecr.CfnRepository.LifecyclePolicyProperty.property.registryId",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`CfnRepository.LifecyclePolicyProperty.RegistryId`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html#cfn-ecr-repository-lifecyclepolicy-registryid"
]
},
"usage": "registry_id: str"
}
],
"docs": {
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-repository-lifecyclepolicy.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnRepository.LifecyclePolicyProperty(\n lifecycle_policy_text: str = None,\n registry_id: str = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.LifecycleRule",
"displayName": "LifecycleRule",
"id": "@aws-cdk/aws-ecr.LifecycleRule",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.LifecycleRule.property.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.LifecycleRule.property.description",
"optional": true,
"default": "No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Describes the purpose of the rule."
},
"usage": "description: str"
},
{
"fqn": "aws_cdk.aws_ecr.LifecycleRule.property.max_image_age",
"displayName": "max_image_age",
"id": "@aws-cdk/aws-ecr.LifecycleRule.property.maxImageAge",
"optional": true,
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.Duration",
"displayName": "Duration",
"fqn": "aws_cdk.core.Duration",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The maximum age of images to retain. The value must represent a number of days.",
"remarks": "Specify exactly one of maxImageCount and maxImageAge."
},
"usage": "max_image_age: Duration"
},
{
"fqn": "aws_cdk.aws_ecr.LifecycleRule.property.max_image_count",
"displayName": "max_image_count",
"id": "@aws-cdk/aws-ecr.LifecycleRule.property.maxImageCount",
"optional": true,
"type": {
"formattingPattern": "typing.Union[int, float]"
},
"docs": {
"summary": "The maximum number of images to retain.",
"remarks": "Specify exactly one of maxImageCount and maxImageAge."
},
"usage": "max_image_count: typing.Union[int, float]"
},
{
"fqn": "aws_cdk.aws_ecr.LifecycleRule.property.rule_priority",
"displayName": "rule_priority",
"id": "@aws-cdk/aws-ecr.LifecycleRule.property.rulePriority",
"optional": true,
"default": "Automatically assigned",
"type": {
"formattingPattern": "typing.Union[int, float]"
},
"docs": {
"summary": "Controls the order in which rules are evaluated (low to high).",
"remarks": "All rules must have a unique priority, where lower numbers have\nhigher precedence. The first rule that matches is applied to an image.\n\nThere can only be one rule with a tagStatus of Any, and it must have\nthe highest rulePriority.\n\nAll rules without a specified priority will have incrementing priorities\nautomatically assigned to them, higher than any rules that DO have priorities."
},
"usage": "rule_priority: typing.Union[int, float]"
},
{
"fqn": "aws_cdk.aws_ecr.LifecycleRule.property.tag_prefix_list",
"displayName": "tag_prefix_list",
"id": "@aws-cdk/aws-ecr.LifecycleRule.property.tagPrefixList",
"optional": true,
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "str"
}
]
},
"docs": {
"summary": "Select images that have ALL the given prefixes in their tag.",
"remarks": "Only if tagStatus == TagStatus.Tagged"
},
"usage": "tag_prefix_list: typing.List[str]"
},
{
"fqn": "aws_cdk.aws_ecr.LifecycleRule.property.tag_status",
"displayName": "tag_status",
"id": "@aws-cdk/aws-ecr.LifecycleRule.property.tagStatus",
"optional": true,
"default": "TagStatus.Tagged if tagPrefixList is given, TagStatus.Any otherwise",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.TagStatus",
"displayName": "TagStatus",
"fqn": "aws_cdk.aws_ecr.TagStatus",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Select images based on tags.",
"remarks": "Only one rule is allowed to select untagged images, and it must\nhave the highest rulePriority."
},
"usage": "tag_status: TagStatus"
}
],
"docs": {
"summary": "An ECR life cycle rule."
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.LifecycleRule(\n description: str = None,\n max_image_age: Duration = None,\n max_image_count: typing.Union[int, float] = None,\n rule_priority: typing.Union[int, float] = None,\n tag_prefix_list: typing.List[str] = None,\n tag_status: TagStatus = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions",
"displayName": "OnCloudTrailImagePushedOptions",
"id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
},
"usage": "description: str"
},
{
"fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
},
"usage": "event_pattern: EventPattern"
},
{
"fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
},
"usage": "rule_name: str"
},
{
"fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
},
"usage": "target: IRuleTarget"
},
{
"fqn": "aws_cdk.aws_ecr.OnCloudTrailImagePushedOptions.property.image_tag",
"displayName": "image_tag",
"id": "@aws-cdk/aws-ecr.OnCloudTrailImagePushedOptions.property.imageTag",
"optional": true,
"default": "- Watch changes to all tags",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Only watch changes to this image tag."
},
"usage": "image_tag: str"
}
],
"docs": {
"summary": "Options for the onCloudTrailImagePushed method."
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.OnCloudTrailImagePushedOptions(\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None,\n image_tag: str = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions",
"displayName": "OnImageScanCompletedOptions",
"id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
},
"usage": "description: str"
},
{
"fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
},
"usage": "event_pattern: EventPattern"
},
{
"fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
},
"usage": "rule_name: str"
},
{
"fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
},
"usage": "target: IRuleTarget"
},
{
"fqn": "aws_cdk.aws_ecr.OnImageScanCompletedOptions.property.image_tags",
"displayName": "image_tags",
"id": "@aws-cdk/aws-ecr.OnImageScanCompletedOptions.property.imageTags",
"optional": true,
"default": "- Watch the changes to the repository with all image tags",
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "str"
}
]
},
"docs": {
"summary": "Only watch changes to the image tags spedified.",
"remarks": "Leave it undefined to watch the full repository."
},
"usage": "image_tags: typing.List[str]"
}
],
"docs": {
"summary": "Options for the OnImageScanCompleted method."
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.OnImageScanCompletedOptions(\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None,\n image_tags: typing.List[str] = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"displayName": "ReplicationConfigurationProperty",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty.property.rules",
"displayName": "rules",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty.property.rules",
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty",
"displayName": "ReplicationRuleProperty",
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
}
]
}
]
},
"docs": {
"summary": "`CfnReplicationConfiguration.ReplicationConfigurationProperty.Rules`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html#cfn-ecr-replicationconfiguration-replicationconfiguration-rules"
]
},
"usage": "rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]]"
}
],
"docs": {
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationconfiguration.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationConfigurationProperty(\n rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationRuleProperty]]]\n)"
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty",
"displayName": "ReplicationDestinationProperty",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.region",
"displayName": "region",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.region",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`CfnReplicationConfiguration.ReplicationDestinationProperty.Region`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-region"
]
},
"usage": "region: str"
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.registry_id",
"displayName": "registry_id",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty.property.registryId",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "`CfnReplicationConfiguration.ReplicationDestinationProperty.RegistryId`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html#cfn-ecr-replicationconfiguration-replicationdestination-registryid"
]
},
"usage": "registry_id: str"
}
],
"docs": {
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationdestination.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty(\n region: str,\n registry_id: str\n)"
},
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty",
"displayName": "ReplicationRuleProperty",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty.property.destinations",
"displayName": "destinations",
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationRuleProperty.property.destinations",
"type": {
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "typing.Union[%, %]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.IResolvable",
"displayName": "IResolvable",
"fqn": "aws_cdk.core.IResolvable",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.CfnReplicationConfiguration.ReplicationDestinationProperty",
"displayName": "ReplicationDestinationProperty",
"fqn": "aws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationDestinationProperty",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
}
]
}
]
},
"docs": {
"summary": "`CfnReplicationConfiguration.ReplicationRuleProperty.Destinations`.",
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html#cfn-ecr-replicationconfiguration-replicationrule-destinations"
]
},
"usage": "destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]]"
}
],
"docs": {
"links": [
"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-replicationconfiguration-replicationrule.html"
]
},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.CfnReplicationConfiguration.ReplicationRuleProperty(\n destinations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationDestinationProperty]]]\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryAttributes",
"displayName": "RepositoryAttributes",
"id": "@aws-cdk/aws-ecr.RepositoryAttributes",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryAttributes.property.repository_arn",
"displayName": "repository_arn",
"id": "@aws-cdk/aws-ecr.RepositoryAttributes.property.repositoryArn",
"type": {
"formattingPattern": "str"
},
"docs": {},
"usage": "repository_arn: str"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryAttributes.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.RepositoryAttributes.property.repositoryName",
"type": {
"formattingPattern": "str"
},
"docs": {},
"usage": "repository_name: str"
}
],
"docs": {},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.RepositoryAttributes(\n repository_arn: str,\n repository_name: str\n)"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryProps",
"displayName": "RepositoryProps",
"id": "@aws-cdk/aws-ecr.RepositoryProps",
"properties": [
{
"fqn": "aws_cdk.aws_ecr.RepositoryProps.property.image_scan_on_push",
"displayName": "image_scan_on_push",
"id": "@aws-cdk/aws-ecr.RepositoryProps.property.imageScanOnPush",
"optional": true,
"default": "false",
"type": {
"formattingPattern": "bool"
},
"docs": {
"summary": "Enable the scan on push when creating the repository."
},
"usage": "image_scan_on_push: bool"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryProps.property.image_tag_mutability",
"displayName": "image_tag_mutability",
"id": "@aws-cdk/aws-ecr.RepositoryProps.property.imageTagMutability",
"optional": true,
"default": "TagMutability.MUTABLE",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.TagMutability",
"displayName": "TagMutability",
"fqn": "aws_cdk.aws_ecr.TagMutability",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The tag mutability setting for the repository.",
"remarks": "If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten."
},
"usage": "image_tag_mutability: TagMutability"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryProps.property.lifecycle_registry_id",
"displayName": "lifecycle_registry_id",
"id": "@aws-cdk/aws-ecr.RepositoryProps.property.lifecycleRegistryId",
"optional": true,
"default": "The default registry is assumed.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The AWS account ID associated with the registry that contains the repository.",
"links": [
"https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.html"
]
},
"usage": "lifecycle_registry_id: str"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryProps.property.lifecycle_rules",
"displayName": "lifecycle_rules",
"id": "@aws-cdk/aws-ecr.RepositoryProps.property.lifecycleRules",
"optional": true,
"default": "No life cycle rules",
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-ecr.LifecycleRule",
"displayName": "LifecycleRule",
"fqn": "aws_cdk.aws_ecr.LifecycleRule",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
]
}
]
},
"docs": {
"summary": "Life cycle rules to apply to this registry."
},
"usage": "lifecycle_rules: typing.List[LifecycleRule]"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryProps.property.removal_policy",
"displayName": "removal_policy",
"id": "@aws-cdk/aws-ecr.RepositoryProps.property.removalPolicy",
"optional": true,
"default": "RemovalPolicy.Retain",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.RemovalPolicy",
"displayName": "RemovalPolicy",
"fqn": "aws_cdk.core.RemovalPolicy",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Determine what happens to the repository when the resource/stack is deleted."
},
"usage": "removal_policy: RemovalPolicy"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryProps.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.RepositoryProps.property.repositoryName",
"optional": true,
"default": "Automatically generated name.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Name for this repository."
},
"usage": "repository_name: str"
}
],
"docs": {},
"usage": "import aws_cdk.aws_ecr\n\naws_cdk.aws_ecr.RepositoryProps(\n image_scan_on_push: bool = None,\n image_tag_mutability: TagMutability = None,\n lifecycle_registry_id: str = None,\n lifecycle_rules: typing.List[LifecycleRule] = None,\n removal_policy: RemovalPolicy = None,\n repository_name: str = None\n)"
}
],
"interfaces": [
{
"fqn": "aws_cdk.aws_ecr.IRepository",
"displayName": "IRepository",
"id": "@aws-cdk/aws-ecr.IRepository",
"implementations": [
{
"fqn": "aws_cdk.aws_ecr.Repository",
"displayName": "Repository",
"id": "@aws-cdk/aws-ecr.Repository",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
},
{
"fqn": "aws_cdk.aws_ecr.RepositoryBase",
"displayName": "RepositoryBase",
"id": "@aws-cdk/aws-ecr.RepositoryBase",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository",
"displayName": "IRepository",
"id": "@aws-cdk/aws-ecr.IRepository",
"packageName": "@aws-cdk/aws-ecr",
"packageVersion": "1.106.0"
}
],
"interfaces": [
{
"fqn": "aws_cdk.core.IResource",
"displayName": "IResource",
"id": "@aws-cdk/core.IResource",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
],
"instanceMethods": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy",
"displayName": "add_to_resource_policy",
"id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.add_to_resource_policy.parameter.statement",
"displayName": "statement",
"id": "@aws-cdk/aws-ecr.IRepository.addToResourcePolicy.parameter.statement",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.PolicyStatement",
"displayName": "PolicyStatement",
"fqn": "aws_cdk.aws_iam.PolicyStatement",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Add a policy statement to the repository's resource policy."
},
"usage": "def add_to_resource_policy(\n statement: PolicyStatement\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.grant",
"displayName": "grant",
"id": "@aws-cdk/aws-ecr.IRepository.grant",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.grant.parameter.actions",
"displayName": "actions",
"id": "@aws-cdk/aws-ecr.IRepository.grant.parameter.actions",
"type": {
"formattingPattern": "str"
},
"docs": {}
}
],
"docs": {
"summary": "Grant the given principal identity permissions to perform the actions on this repository."
},
"usage": "def grant(\n grantee: IGrantable,\n actions: str\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.grant_pull",
"displayName": "grant_pull",
"id": "@aws-cdk/aws-ecr.IRepository.grantPull",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.grant_pull.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.IRepository.grantPull.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Grant the given identity permissions to pull images in this repository."
},
"usage": "def grant_pull(\n grantee: IGrantable\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push",
"displayName": "grant_pull_push",
"id": "@aws-cdk/aws-ecr.IRepository.grantPullPush",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.grant_pull_push.parameter.grantee",
"displayName": "grantee",
"id": "@aws-cdk/aws-ecr.IRepository.grantPullPush.parameter.grantee",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-iam.IGrantable",
"displayName": "IGrantable",
"fqn": "aws_cdk.aws_iam.IGrantable",
"packageName": "@aws-cdk/aws-iam",
"packageVersion": "1.106.0"
}
]
},
"docs": {}
}
],
"docs": {
"summary": "Grant the given identity permissions to pull and push images to this repository."
},
"usage": "def grant_pull_push(\n grantee: IGrantable\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event",
"displayName": "on_cloud_trail_event",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The id of the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_event.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailEvent.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
}
],
"docs": {
"summary": "Define a CloudWatch event that triggers when something happens to this repository.",
"remarks": "Requires that there exists at least one CloudTrail Trail in your account\nthat captures the event. This method will not create the Trail."
},
"usage": "def on_cloud_trail_event(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed",
"displayName": "on_cloud_trail_image_pushed",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The id of the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_cloud_trail_image_pushed.parameter.image_tag",
"displayName": "image_tag",
"id": "@aws-cdk/aws-ecr.IRepository.onCloudTrailImagePushed.parameter.imageTag",
"optional": true,
"default": "- Watch changes to all tags",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Only watch changes to this image tag."
}
}
],
"docs": {
"summary": "Defines an AWS CloudWatch event rule that can trigger a target when an image is pushed to this repository.",
"remarks": "Requires that there exists at least one CloudTrail Trail in your account\nthat captures the event. This method will not create the Trail."
},
"usage": "def on_cloud_trail_image_pushed(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None,\n image_tag: str = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_event",
"displayName": "on_event",
"id": "@aws-cdk/aws-ecr.IRepository.onEvent",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_event.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.IRepository.onEvent.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
}
],
"docs": {
"summary": "Defines a CloudWatch event rule which triggers for repository events.",
"remarks": "Use\n`rule.addEventPattern(pattern)` to specify a filter."
},
"usage": "def on_event(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed",
"displayName": "on_image_scan_completed",
"id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.id",
"displayName": "id",
"id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.id",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The id of the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.description",
"displayName": "description",
"id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.description",
"optional": true,
"default": "- No description",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A description of the rule's purpose."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.event_pattern",
"displayName": "event_pattern",
"id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.eventPattern",
"optional": true,
"default": "- No additional filtering based on an event pattern.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.EventPattern",
"displayName": "EventPattern",
"fqn": "aws_cdk.aws_events.EventPattern",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "Additional restrictions for the event to route to the specified target.",
"remarks": "The method that generates the rule probably imposes some type of event\nfiltering. The filtering implied by what you pass here is added\non top of that filtering.",
"links": [
"https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html"
]
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.rule_name",
"displayName": "rule_name",
"id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.ruleName",
"optional": true,
"default": "AWS CloudFormation generates a unique physical ID.",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "A name for the rule."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.target",
"displayName": "target",
"id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.target",
"optional": true,
"default": "- No target is added to the rule. Use `addTarget()` to add a target.",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/aws-events.IRuleTarget",
"displayName": "IRuleTarget",
"fqn": "aws_cdk.aws_events.IRuleTarget",
"packageName": "@aws-cdk/aws-events",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The target to register for the event."
}
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.on_image_scan_completed.parameter.image_tags",
"displayName": "image_tags",
"id": "@aws-cdk/aws-ecr.IRepository.onImageScanCompleted.parameter.imageTags",
"optional": true,
"default": "- Watch the changes to the repository with all image tags",
"type": {
"formattingPattern": "typing.List[%]",
"types": [
{
"formattingPattern": "str"
}
]
},
"docs": {
"summary": "Only watch changes to the image tags spedified.",
"remarks": "Leave it undefined to watch the full repository."
}
}
],
"docs": {
"summary": "Defines an AWS CloudWatch event rule that can trigger a target when the image scan is completed."
},
"usage": "def on_image_scan_completed(\n id: str,\n description: str = None,\n event_pattern: EventPattern = None,\n rule_name: str = None,\n target: IRuleTarget = None,\n image_tags: typing.List[str] = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest",
"displayName": "repository_uri_for_digest",
"id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_digest.parameter.digest",
"displayName": "digest",
"id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForDigest.parameter.digest",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Image digest to use (tools usually default to the image with the \"latest\" tag if omitted)."
}
}
],
"docs": {
"summary": "Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.",
"remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[@DIGEST]"
},
"usage": "def repository_uri_for_digest(\n digest: str = None\n)"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag",
"displayName": "repository_uri_for_tag",
"id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag",
"parameters": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.repository_uri_for_tag.parameter.tag",
"displayName": "tag",
"id": "@aws-cdk/aws-ecr.IRepository.repositoryUriForTag.parameter.tag",
"optional": true,
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "Image tag to use (tools usually default to \"latest\" if omitted)."
}
}
],
"docs": {
"summary": "Returns the URI of the repository for a certain tag. Can be used in `docker push/pull`.",
"remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]"
},
"usage": "def repository_uri_for_tag(\n tag: str = None\n)"
}
],
"properties": [
{
"fqn": "aws_cdk.aws_ecr.IRepository.property.node",
"displayName": "node",
"id": "@aws-cdk/aws-ecr.IRepository.property.node",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.ConstructNode",
"displayName": "ConstructNode",
"fqn": "aws_cdk.core.ConstructNode",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The construct tree node for this construct."
},
"usage": "node: ConstructNode"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.property.env",
"displayName": "env",
"id": "@aws-cdk/aws-ecr.IRepository.property.env",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.ResourceEnvironment",
"displayName": "ResourceEnvironment",
"fqn": "aws_cdk.core.ResourceEnvironment",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The environment this resource belongs to.",
"remarks": "For resources that are created and managed by the CDK\n(generally, those created by creating new class instances like Role, Bucket, etc.),\nthis is always the same as the environment of the stack they belong to;\nhowever, for imported resources\n(those obtained from static methods like fromRoleArn, fromBucketName, etc.),\nthat might be different than the stack they were imported into."
},
"usage": "env: ResourceEnvironment"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.property.stack",
"displayName": "stack",
"id": "@aws-cdk/aws-ecr.IRepository.property.stack",
"type": {
"formattingPattern": "%",
"types": [
{
"id": "@aws-cdk/core.Stack",
"displayName": "Stack",
"fqn": "aws_cdk.core.Stack",
"packageName": "@aws-cdk/core",
"packageVersion": "1.106.0"
}
]
},
"docs": {
"summary": "The stack in which this resource is defined."
},
"usage": "stack: Stack"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.property.repository_arn",
"displayName": "repository_arn",
"id": "@aws-cdk/aws-ecr.IRepository.property.repositoryArn",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The ARN of the repository."
},
"usage": "repository_arn: str"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.property.repository_name",
"displayName": "repository_name",
"id": "@aws-cdk/aws-ecr.IRepository.property.repositoryName",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The name of the repository."
},
"usage": "repository_name: str"
},
{
"fqn": "aws_cdk.aws_ecr.IRepository.property.repository_uri",
"displayName": "repository_uri",
"id": "@aws-cdk/aws-ecr.IRepository.property.repositoryUri",
"type": {
"formattingPattern": "str"
},
"docs": {
"summary": "The URI of this repository (represents the latest image):.",
"remarks": "ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY"
},
"usage": "repository_uri: str"
}
],
"docs": {
"summary": "Represents an ECR repository."
}
}
],
"enums": [
{
"fqn": "aws_cdk.aws_ecr.TagMutability",
"displayName": "TagMutability",
"id": "@aws-cdk/aws-ecr.TagMutability",
"members": [
{
"id": "@aws-cdk/aws-ecr.TagMutability.MUTABLE",
"displayName": "MUTABLE",
"fqn": "aws_cdk.aws_ecr.TagMutability.MUTABLE",
"docs": {
"summary": "allow image tags to be overwritten."
}
},
{
"id": "@aws-cdk/aws-ecr.TagMutability.IMMUTABLE",
"displayName": "IMMUTABLE",
"fqn": "aws_cdk.aws_ecr.TagMutability.IMMUTABLE",
"docs": {
"summary": "all image tags within the repository will be immutable which will prevent them from being overwritten."
}
}
],
"docs": {
"summary": "The tag mutability setting for your repository."
}
},
{
"fqn": "aws_cdk.aws_ecr.TagStatus",
"displayName": "TagStatus",
"id": "@aws-cdk/aws-ecr.TagStatus",
"members": [
{
"id": "@aws-cdk/aws-ecr.TagStatus.ANY",
"displayName": "ANY",
"fqn": "aws_cdk.aws_ecr.TagStatus.ANY",
"docs": {
"summary": "Rule applies to all images."
}
},
{
"id": "@aws-cdk/aws-ecr.TagStatus.TAGGED",
"displayName": "TAGGED",
"fqn": "aws_cdk.aws_ecr.TagStatus.TAGGED",
"docs": {
"summary": "Rule applies to tagged images."
}
},
{
"id": "@aws-cdk/aws-ecr.TagStatus.UNTAGGED",
"displayName": "UNTAGGED",
"fqn": "aws_cdk.aws_ecr.TagStatus.UNTAGGED",
"docs": {
"summary": "Rule applies to untagged images."
}
}
],
"docs": {
"summary": "Select images based on tags."
}
}
]
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment