Skip to content

RegistryMapping

Source code in docs_src/capo_omics/types/registry_mapping.py
class RegistryMapping(TypedDict, closed=True):
    upstream_registry_url: NotRequired["capo_omics.types.uri.Uri"]
    """<p>The URI of the upstream registry.</p>"""
    ecr_repository_prefix: NotRequired[
        "capo_omics.types.ecr_repository_prefix.EcrRepositoryPrefix"
    ]
    """<p>The repository prefix to use in the ECR private repository.</p>"""
    upstream_repository_prefix: NotRequired[
        "capo_omics.types.upstream_repository_prefix.UpstreamRepositoryPrefix"
    ]
    """<p>The repository prefix of the corresponding repository in the upstream registry.</p>"""
    ecr_account_id: NotRequired["capo_omics.types.aws_account_id.AwsAccountId"]
    """<p>Account ID of the account that owns the upstream container image.</p>"""
    credential_arn: NotRequired["capo_omics.types.secret_arn.SecretArn"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that holds the credentials for the upstream registry. You must specify this value when Amazon Elastic Container Registry (Amazon ECR) doesn't support pull through cache for the upstream registry. HealthOmics supports only some of these registries. The workflow role must have permission to call the <code>secretsmanager:GetSecretValue</code> operation on the secret. For more information about the supported registries, see <a href="https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html">Container images</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>"""

credential_arn instance-attribute

credential_arn: NotRequired[SecretArn]

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that holds the credentials for the upstream registry. You must specify this value when Amazon Elastic Container Registry (Amazon ECR) doesn't support pull through cache for the upstream registry. HealthOmics supports only some of these registries. The workflow role must have permission to call the secretsmanager:GetSecretValue operation on the secret. For more information about the supported registries, see Container images in the Amazon Web Services HealthOmics User Guide.

ecr_account_id instance-attribute

ecr_account_id: NotRequired[AwsAccountId]

Account ID of the account that owns the upstream container image.

ecr_repository_prefix instance-attribute

ecr_repository_prefix: NotRequired[EcrRepositoryPrefix]

The repository prefix to use in the ECR private repository.

upstream_registry_url instance-attribute

upstream_registry_url: NotRequired[Uri]

The URI of the upstream registry.

upstream_repository_prefix instance-attribute

upstream_repository_prefix: NotRequired[UpstreamRepositoryPrefix]

The repository prefix of the corresponding repository in the upstream registry.