Aws/ecr
@swamp/aws/ecrv2026.07.27.1
01README
AWS ECR infrastructure models
02Models
@swamp/aws/ecr/public-repositoryv2026.06.15.1public_repository.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| RepositoryName? | string | The name to use for the public repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you canno |
| RepositoryPolicyText? | record | The JSON repository policy text to apply to the public repository. For more information, see [Amazon ECR Public repository policies](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policies.html) in the *Amazon ECR Public User Guide*. |
| RepositoryCatalogData? | object | The details about the repository that are publicly visible in the Amazon ECR Public Gallery. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a ECR PublicRepository
fn get(identifier: string)
Get a ECR PublicRepository
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR PublicRepository |
fn update()
Update a ECR PublicRepository
fn delete(identifier: string)
Delete a ECR PublicRepository
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR PublicRepository |
fn sync()
Sync ECR PublicRepository state from AWS
Resources
state(infinite)— ECR PublicRepository resource state
@swamp/aws/ecr/pull-through-cache-rulev2026.06.28.1pull_through_cache_rule.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| EcrRepositoryPrefix? | string | The Amazon ECR repository prefix associated with the pull through cache rule. |
| UpstreamRegistryUrl? | string | The upstream registry URL associated with the pull through cache rule. |
| CredentialArn? | string | The ARN of the Secrets Manager secret associated with the pull through cache rule. |
| UpstreamRegistry? | string | The name of the upstream source registry associated with the pull through cache rule. |
| CustomRoleArn? | string | The ARN of the IAM role associated with the pull through cache rule. |
| UpstreamRepositoryPrefix? | string | The upstream repository prefix associated with the pull through cache rule. |
fn create()
Create a ECR PullThroughCacheRule
fn get(identifier: string)
Get a ECR PullThroughCacheRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR PullThroughCacheRule |
fn update()
Update a ECR PullThroughCacheRule
fn delete(identifier: string)
Delete a ECR PullThroughCacheRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR PullThroughCacheRule |
fn sync()
Sync ECR PullThroughCacheRule state from AWS
Resources
state(infinite)— ECR PullThroughCacheRule resource state
@swamp/aws/ecr/pull-time-update-exclusionv2026.06.15.1pull_time_update_exclusion.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| PrincipalArn | string | The ARN of the IAM principal to remove from the pull time update exclusion list. |
fn create()
Create a ECR PullTimeUpdateExclusion
fn get(identifier: string)
Get a ECR PullTimeUpdateExclusion
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR PullTimeUpdateExclusion |
fn delete(identifier: string)
Delete a ECR PullTimeUpdateExclusion
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR PullTimeUpdateExclusion |
fn sync()
Sync ECR PullTimeUpdateExclusion state from AWS
Resources
state(infinite)— ECR PullTimeUpdateExclusion resource state
@swamp/aws/ecr/registry-policyv2026.06.15.1registry_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| PolicyText | record | The JSON policy text for your registry. |
fn create()
Create a ECR RegistryPolicy
fn get(identifier: string)
Get a ECR RegistryPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR RegistryPolicy |
fn update()
Update a ECR RegistryPolicy
fn delete(identifier: string)
Delete a ECR RegistryPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR RegistryPolicy |
fn sync()
Sync ECR RegistryPolicy state from AWS
Resources
state(infinite)— ECR RegistryPolicy resource state
@swamp/aws/ecr/registry-scanning-configurationv2026.06.15.1registry_scanning_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Rules | array | The scanning rules associated with the registry. |
| ScanType | enum | The type of scanning configured for the registry. |
fn create()
Create a ECR RegistryScanningConfiguration
fn get(identifier: string)
Get a ECR RegistryScanningConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR RegistryScanningConfiguration |
fn update()
Update a ECR RegistryScanningConfiguration
fn delete(identifier: string)
Delete a ECR RegistryScanningConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR RegistryScanningConfiguration |
fn sync()
Sync ECR RegistryScanningConfiguration state from AWS
Resources
state(infinite)— ECR RegistryScanningConfiguration resource state
@swamp/aws/ecr/replication-configurationv2026.06.15.1replication_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ReplicationConfiguration | object | The replication configuration for a registry. |
fn create()
Create a ECR ReplicationConfiguration
fn get(identifier: string)
Get a ECR ReplicationConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR ReplicationConfiguration |
fn update()
Update a ECR ReplicationConfiguration
fn delete(identifier: string)
Delete a ECR ReplicationConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR ReplicationConfiguration |
fn sync()
Sync ECR ReplicationConfiguration state from AWS
Resources
state(infinite)— ECR ReplicationConfiguration resource state
@swamp/aws/ecr/repositoryv2026.06.15.1repository.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| EmptyOnDelete? | boolean | If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. |
| LifecyclePolicy? | object | Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). |
| RepositoryName? | string | The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). The repository name must start with a l |
| RepositoryPolicyText? | record | The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| ImageTagMutability? | enum | The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. |
| ImageTagMutabilityExclusionFilters? | array | A list of filters that specify which image tags are excluded from the repository's image tag mutability setting. |
| ImageScanningConfiguration? | object | The imageScanningConfiguration parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration. The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. |
| EncryptionConfiguration? | object | The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. |
fn create()
Create a ECR Repository
fn get(identifier: string)
Get a ECR Repository
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR Repository |
fn update()
Update a ECR Repository
fn delete(identifier: string)
Delete a ECR Repository
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR Repository |
fn sync()
Sync ECR Repository state from AWS
Resources
state(infinite)— ECR Repository resource state
@swamp/aws/ecr/repository-creation-templatev2026.06.15.1repository_creation_template.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Prefix | string | The repository namespace prefix associated with the repository creation template. |
| Description? | string | The description associated with the repository creation template. |
| ImageTagMutability? | enum | The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. |
| ImageTagMutabilityExclusionFilters? | array | A list of filters that specify which image tags are excluded from the repository creation template's image tag mutability setting. |
| RepositoryPolicy? | string | The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions. |
| LifecyclePolicy? | string | The lifecycle policy to use for repositories created using the template. |
| EncryptionConfiguration? | object | The encryption configuration associated with the repository creation template. |
| ResourceTags? | array | The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
| AppliedFor | array | A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH |
| CustomRoleArn? | string | The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template. |
fn create()
Create a ECR RepositoryCreationTemplate
fn get(identifier: string)
Get a ECR RepositoryCreationTemplate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR RepositoryCreationTemplate |
fn update()
Update a ECR RepositoryCreationTemplate
fn delete(identifier: string)
Delete a ECR RepositoryCreationTemplate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR RepositoryCreationTemplate |
fn sync()
Sync ECR RepositoryCreationTemplate state from AWS
Resources
state(infinite)— ECR RepositoryCreationTemplate resource state
@swamp/aws/ecr/signing-configurationv2026.06.15.1signing_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Rules | array | Array of signing rules that define which repositories should be signed and with which signing profiles. |
fn create()
Create a ECR SigningConfiguration
fn get(identifier: string)
Get a ECR SigningConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR SigningConfiguration |
fn update()
Update a ECR SigningConfiguration
fn delete(identifier: string)
Delete a ECR SigningConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ECR SigningConfiguration |
fn sync()
Sync ECR SigningConfiguration state from AWS
Resources
state(infinite)— ECR SigningConfiguration resource state
03Previous Versions
2026.07.26.1
2026.07.25.1
2026.07.24.1
2026.07.20.1
2026.07.18.3
2026.07.18.2
2026.06.28.1
- Updated: pull_through_cache_rule
2026.06.15.1
- Updated: public_repository, pull_through_cache_rule, pull_time_update_exclusion, registry_policy, registry_scanning_configuration, replication_configuration, repository, repository_creation_template, signing_configuration
2026.06.08.2
- Updated: public_repository, pull_through_cache_rule, pull_time_update_exclusion, registry_policy, registry_scanning_configuration, replication_configuration, repository, repository_creation_template, signing_configuration
2026.06.06.1
- Updated: public_repository, pull_through_cache_rule, pull_time_update_exclusion, registry_policy, registry_scanning_configuration, replication_configuration, repository, repository_creation_template, signing_configuration
2026.05.27.1
- Updated: public_repository, registry_policy, repository
2026.05.19.1
2026.04.23.3
2026.04.23.2
- Updated: public_repository, pull_through_cache_rule, pull_time_update_exclusion, registry_policy, registry_scanning_configuration, replication_configuration, repository, repository_creation_template, signing_configuration
2026.04.03.2
- Updated: public_repository, pull_through_cache_rule, pull_time_update_exclusion, registry_policy, registry_scanning_configuration, replication_configuration, repository, repository_creation_template, signing_configuration
2026.03.19.1
- Updated: public_repository, pull_through_cache_rule, pull_time_update_exclusion, registry_policy, registry_scanning_configuration, replication_configuration, repository, repository_creation_template, signing_configuration
2026.03.16.1
- Updated: public_repository, pull_through_cache_rule, pull_time_update_exclusion, registry_policy, registry_scanning_configuration, replication_configuration, repository, repository_creation_template, signing_configuration
2026.03.10.5
04Stats
A
100 / 100
Downloads
36
Archive size
2.0 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels