1. Packages
  2. AWS
  3. API Docs
  4. ecr
  5. getRepository
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.ecr.getRepository

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    The ECR Repository data source allows the ARN, Repository URI and Registry ID to be retrieved for an ECR repository.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const service = aws.ecr.getRepository({
        name: "ecr-repository",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    service = aws.ecr.get_repository(name="ecr-repository")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecr"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ecr.LookupRepository(ctx, &ecr.LookupRepositoryArgs{
    			Name: "ecr-repository",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var service = Aws.Ecr.GetRepository.Invoke(new()
        {
            Name = "ecr-repository",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ecr.EcrFunctions;
    import com.pulumi.aws.ecr.inputs.GetRepositoryArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var service = EcrFunctions.getRepository(GetRepositoryArgs.builder()
                .name("ecr-repository")
                .build());
    
        }
    }
    
    variables:
      service:
        fn::invoke:
          Function: aws:ecr:getRepository
          Arguments:
            name: ecr-repository
    

    Using getRepository

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRepository(args: GetRepositoryArgs, opts?: InvokeOptions): Promise<GetRepositoryResult>
    function getRepositoryOutput(args: GetRepositoryOutputArgs, opts?: InvokeOptions): Output<GetRepositoryResult>
    def get_repository(name: Optional[str] = None,
                       registry_id: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRepositoryResult
    def get_repository_output(name: Optional[pulumi.Input[str]] = None,
                       registry_id: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRepositoryResult]
    func LookupRepository(ctx *Context, args *LookupRepositoryArgs, opts ...InvokeOption) (*LookupRepositoryResult, error)
    func LookupRepositoryOutput(ctx *Context, args *LookupRepositoryOutputArgs, opts ...InvokeOption) LookupRepositoryResultOutput

    > Note: This function is named LookupRepository in the Go SDK.

    public static class GetRepository 
    {
        public static Task<GetRepositoryResult> InvokeAsync(GetRepositoryArgs args, InvokeOptions? opts = null)
        public static Output<GetRepositoryResult> Invoke(GetRepositoryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRepositoryResult> getRepository(GetRepositoryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:ecr/getRepository:getRepository
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the ECR Repository.
    RegistryId string
    Registry ID where the repository was created.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    Name string
    Name of the ECR Repository.
    RegistryId string
    Registry ID where the repository was created.
    Tags map[string]string
    Map of tags assigned to the resource.
    name String
    Name of the ECR Repository.
    registryId String
    Registry ID where the repository was created.
    tags Map<String,String>
    Map of tags assigned to the resource.
    name string
    Name of the ECR Repository.
    registryId string
    Registry ID where the repository was created.
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    name str
    Name of the ECR Repository.
    registry_id str
    Registry ID where the repository was created.
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    name String
    Name of the ECR Repository.
    registryId String
    Registry ID where the repository was created.
    tags Map<String>
    Map of tags assigned to the resource.

    getRepository Result

    The following output properties are available:

    Arn string
    Full ARN of the repository.
    EncryptionConfigurations List<GetRepositoryEncryptionConfiguration>
    Encryption configuration for the repository. See Encryption Configuration below.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageScanningConfigurations List<GetRepositoryImageScanningConfiguration>
    Configuration block that defines image scanning configuration for the repository. See Image Scanning Configuration below.
    ImageTagMutability string
    The tag mutability setting for the repository.
    MostRecentImageTags List<string>
    List of image tags associated with the most recently pushed image in the repository.
    Name string
    RegistryId string
    RepositoryUrl string
    URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    Arn string
    Full ARN of the repository.
    EncryptionConfigurations []GetRepositoryEncryptionConfiguration
    Encryption configuration for the repository. See Encryption Configuration below.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageScanningConfigurations []GetRepositoryImageScanningConfiguration
    Configuration block that defines image scanning configuration for the repository. See Image Scanning Configuration below.
    ImageTagMutability string
    The tag mutability setting for the repository.
    MostRecentImageTags []string
    List of image tags associated with the most recently pushed image in the repository.
    Name string
    RegistryId string
    RepositoryUrl string
    URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).
    Tags map[string]string
    Map of tags assigned to the resource.
    arn String
    Full ARN of the repository.
    encryptionConfigurations List<GetRepositoryEncryptionConfiguration>
    Encryption configuration for the repository. See Encryption Configuration below.
    id String
    The provider-assigned unique ID for this managed resource.
    imageScanningConfigurations List<GetRepositoryImageScanningConfiguration>
    Configuration block that defines image scanning configuration for the repository. See Image Scanning Configuration below.
    imageTagMutability String
    The tag mutability setting for the repository.
    mostRecentImageTags List<String>
    List of image tags associated with the most recently pushed image in the repository.
    name String
    registryId String
    repositoryUrl String
    URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).
    tags Map<String,String>
    Map of tags assigned to the resource.
    arn string
    Full ARN of the repository.
    encryptionConfigurations GetRepositoryEncryptionConfiguration[]
    Encryption configuration for the repository. See Encryption Configuration below.
    id string
    The provider-assigned unique ID for this managed resource.
    imageScanningConfigurations GetRepositoryImageScanningConfiguration[]
    Configuration block that defines image scanning configuration for the repository. See Image Scanning Configuration below.
    imageTagMutability string
    The tag mutability setting for the repository.
    mostRecentImageTags string[]
    List of image tags associated with the most recently pushed image in the repository.
    name string
    registryId string
    repositoryUrl string
    URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    arn str
    Full ARN of the repository.
    encryption_configurations Sequence[GetRepositoryEncryptionConfiguration]
    Encryption configuration for the repository. See Encryption Configuration below.
    id str
    The provider-assigned unique ID for this managed resource.
    image_scanning_configurations Sequence[GetRepositoryImageScanningConfiguration]
    Configuration block that defines image scanning configuration for the repository. See Image Scanning Configuration below.
    image_tag_mutability str
    The tag mutability setting for the repository.
    most_recent_image_tags Sequence[str]
    List of image tags associated with the most recently pushed image in the repository.
    name str
    registry_id str
    repository_url str
    URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    arn String
    Full ARN of the repository.
    encryptionConfigurations List<Property Map>
    Encryption configuration for the repository. See Encryption Configuration below.
    id String
    The provider-assigned unique ID for this managed resource.
    imageScanningConfigurations List<Property Map>
    Configuration block that defines image scanning configuration for the repository. See Image Scanning Configuration below.
    imageTagMutability String
    The tag mutability setting for the repository.
    mostRecentImageTags List<String>
    List of image tags associated with the most recently pushed image in the repository.
    name String
    registryId String
    repositoryUrl String
    URL of the repository (in the form aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName).
    tags Map<String>
    Map of tags assigned to the resource.

    Supporting Types

    GetRepositoryEncryptionConfiguration

    EncryptionType string
    Encryption type to use for the repository, either AES256 or KMS.
    KmsKey string
    If encryption_type is KMS, the ARN of the KMS key used.
    EncryptionType string
    Encryption type to use for the repository, either AES256 or KMS.
    KmsKey string
    If encryption_type is KMS, the ARN of the KMS key used.
    encryptionType String
    Encryption type to use for the repository, either AES256 or KMS.
    kmsKey String
    If encryption_type is KMS, the ARN of the KMS key used.
    encryptionType string
    Encryption type to use for the repository, either AES256 or KMS.
    kmsKey string
    If encryption_type is KMS, the ARN of the KMS key used.
    encryption_type str
    Encryption type to use for the repository, either AES256 or KMS.
    kms_key str
    If encryption_type is KMS, the ARN of the KMS key used.
    encryptionType String
    Encryption type to use for the repository, either AES256 or KMS.
    kmsKey String
    If encryption_type is KMS, the ARN of the KMS key used.

    GetRepositoryImageScanningConfiguration

    ScanOnPush bool
    Whether images are scanned after being pushed to the repository.
    ScanOnPush bool
    Whether images are scanned after being pushed to the repository.
    scanOnPush Boolean
    Whether images are scanned after being pushed to the repository.
    scanOnPush boolean
    Whether images are scanned after being pushed to the repository.
    scan_on_push bool
    Whether images are scanned after being pushed to the repository.
    scanOnPush Boolean
    Whether images are scanned after being pushed to the repository.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi