github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/sagemaker/getPrebuiltEcrImage.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package sagemaker
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Get information about prebuilt Amazon SageMaker Docker images.
    15  //
    16  // > **NOTE:** The AWS provider creates a validly constructed `registryPath` but does not verify that the `registryPath` corresponds to an existing image. For example, using a `registryPath` containing an `imageTag` that does not correspond to a Docker image in the ECR repository, will result in an error.
    17  //
    18  // ## Example Usage
    19  //
    20  // Basic usage:
    21  //
    22  // <!--Start PulumiCodeChooser -->
    23  // ```go
    24  // package main
    25  //
    26  // import (
    27  //
    28  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
    29  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    30  //
    31  // )
    32  //
    33  //	func main() {
    34  //		pulumi.Run(func(ctx *pulumi.Context) error {
    35  //			_, err := sagemaker.GetPrebuiltEcrImage(ctx, &sagemaker.GetPrebuiltEcrImageArgs{
    36  //				RepositoryName: "sagemaker-scikit-learn",
    37  //				ImageTag:       pulumi.StringRef("2.2-1.0.11.0"),
    38  //			}, nil)
    39  //			if err != nil {
    40  //				return err
    41  //			}
    42  //			return nil
    43  //		})
    44  //	}
    45  //
    46  // ```
    47  // <!--End PulumiCodeChooser -->
    48  func GetPrebuiltEcrImage(ctx *pulumi.Context, args *GetPrebuiltEcrImageArgs, opts ...pulumi.InvokeOption) (*GetPrebuiltEcrImageResult, error) {
    49  	opts = internal.PkgInvokeDefaultOpts(opts)
    50  	var rv GetPrebuiltEcrImageResult
    51  	err := ctx.Invoke("aws:sagemaker/getPrebuiltEcrImage:getPrebuiltEcrImage", args, &rv, opts...)
    52  	if err != nil {
    53  		return nil, err
    54  	}
    55  	return &rv, nil
    56  }
    57  
    58  // A collection of arguments for invoking getPrebuiltEcrImage.
    59  type GetPrebuiltEcrImageArgs struct {
    60  	// DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
    61  	DnsSuffix *string `pulumi:"dnsSuffix"`
    62  	// Image tag for the Docker image. If not specified, the AWS provider sets the value to `1`, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support `1` or `latest` and specific version must be used.
    63  	ImageTag *string `pulumi:"imageTag"`
    64  	// Region to use in the registry path. If not specified, the AWS provider sets it to the current region.
    65  	Region *string `pulumi:"region"`
    66  	// Name of the repository, which is generally the algorithm or library. Values include `blazingtext`, `factorization-machines`, `forecasting-deepar`, `image-classification`, `ipinsights`, `kmeans`, `knn`, `lda`, `linear-learner`, `mxnet-inference-eia`, `mxnet-inference`, `mxnet-training`, `ntm`, `object-detection`, `object2vec`, `pca`, `pytorch-inference-eia`, `pytorch-inference`, `pytorch-training`, `randomcutforest`, `sagemaker-scikit-learn`, `sagemaker-sparkml-serving`, `sagemaker-xgboost`, `semantic-segmentation`, `seq2seq`, `tensorflow-inference-eia`, `tensorflow-inference`, `tensorflow-training`, `huggingface-tensorflow-training`, `huggingface-tensorflow-inference`, `huggingface-pytorch-training`, and `huggingface-pytorch-inference`.
    67  	RepositoryName string `pulumi:"repositoryName"`
    68  }
    69  
    70  // A collection of values returned by getPrebuiltEcrImage.
    71  type GetPrebuiltEcrImageResult struct {
    72  	DnsSuffix *string `pulumi:"dnsSuffix"`
    73  	// The provider-assigned unique ID for this managed resource.
    74  	Id       string  `pulumi:"id"`
    75  	ImageTag *string `pulumi:"imageTag"`
    76  	Region   *string `pulumi:"region"`
    77  	// Account ID containing the image. For example, `469771592824`.
    78  	RegistryId string `pulumi:"registryId"`
    79  	// Docker image URL. For example, `341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4`.
    80  	RegistryPath   string `pulumi:"registryPath"`
    81  	RepositoryName string `pulumi:"repositoryName"`
    82  }
    83  
    84  func GetPrebuiltEcrImageOutput(ctx *pulumi.Context, args GetPrebuiltEcrImageOutputArgs, opts ...pulumi.InvokeOption) GetPrebuiltEcrImageResultOutput {
    85  	return pulumi.ToOutputWithContext(context.Background(), args).
    86  		ApplyT(func(v interface{}) (GetPrebuiltEcrImageResult, error) {
    87  			args := v.(GetPrebuiltEcrImageArgs)
    88  			r, err := GetPrebuiltEcrImage(ctx, &args, opts...)
    89  			var s GetPrebuiltEcrImageResult
    90  			if r != nil {
    91  				s = *r
    92  			}
    93  			return s, err
    94  		}).(GetPrebuiltEcrImageResultOutput)
    95  }
    96  
    97  // A collection of arguments for invoking getPrebuiltEcrImage.
    98  type GetPrebuiltEcrImageOutputArgs struct {
    99  	// DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region.
   100  	DnsSuffix pulumi.StringPtrInput `pulumi:"dnsSuffix"`
   101  	// Image tag for the Docker image. If not specified, the AWS provider sets the value to `1`, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support `1` or `latest` and specific version must be used.
   102  	ImageTag pulumi.StringPtrInput `pulumi:"imageTag"`
   103  	// Region to use in the registry path. If not specified, the AWS provider sets it to the current region.
   104  	Region pulumi.StringPtrInput `pulumi:"region"`
   105  	// Name of the repository, which is generally the algorithm or library. Values include `blazingtext`, `factorization-machines`, `forecasting-deepar`, `image-classification`, `ipinsights`, `kmeans`, `knn`, `lda`, `linear-learner`, `mxnet-inference-eia`, `mxnet-inference`, `mxnet-training`, `ntm`, `object-detection`, `object2vec`, `pca`, `pytorch-inference-eia`, `pytorch-inference`, `pytorch-training`, `randomcutforest`, `sagemaker-scikit-learn`, `sagemaker-sparkml-serving`, `sagemaker-xgboost`, `semantic-segmentation`, `seq2seq`, `tensorflow-inference-eia`, `tensorflow-inference`, `tensorflow-training`, `huggingface-tensorflow-training`, `huggingface-tensorflow-inference`, `huggingface-pytorch-training`, and `huggingface-pytorch-inference`.
   106  	RepositoryName pulumi.StringInput `pulumi:"repositoryName"`
   107  }
   108  
   109  func (GetPrebuiltEcrImageOutputArgs) ElementType() reflect.Type {
   110  	return reflect.TypeOf((*GetPrebuiltEcrImageArgs)(nil)).Elem()
   111  }
   112  
   113  // A collection of values returned by getPrebuiltEcrImage.
   114  type GetPrebuiltEcrImageResultOutput struct{ *pulumi.OutputState }
   115  
   116  func (GetPrebuiltEcrImageResultOutput) ElementType() reflect.Type {
   117  	return reflect.TypeOf((*GetPrebuiltEcrImageResult)(nil)).Elem()
   118  }
   119  
   120  func (o GetPrebuiltEcrImageResultOutput) ToGetPrebuiltEcrImageResultOutput() GetPrebuiltEcrImageResultOutput {
   121  	return o
   122  }
   123  
   124  func (o GetPrebuiltEcrImageResultOutput) ToGetPrebuiltEcrImageResultOutputWithContext(ctx context.Context) GetPrebuiltEcrImageResultOutput {
   125  	return o
   126  }
   127  
   128  func (o GetPrebuiltEcrImageResultOutput) DnsSuffix() pulumi.StringPtrOutput {
   129  	return o.ApplyT(func(v GetPrebuiltEcrImageResult) *string { return v.DnsSuffix }).(pulumi.StringPtrOutput)
   130  }
   131  
   132  // The provider-assigned unique ID for this managed resource.
   133  func (o GetPrebuiltEcrImageResultOutput) Id() pulumi.StringOutput {
   134  	return o.ApplyT(func(v GetPrebuiltEcrImageResult) string { return v.Id }).(pulumi.StringOutput)
   135  }
   136  
   137  func (o GetPrebuiltEcrImageResultOutput) ImageTag() pulumi.StringPtrOutput {
   138  	return o.ApplyT(func(v GetPrebuiltEcrImageResult) *string { return v.ImageTag }).(pulumi.StringPtrOutput)
   139  }
   140  
   141  func (o GetPrebuiltEcrImageResultOutput) Region() pulumi.StringPtrOutput {
   142  	return o.ApplyT(func(v GetPrebuiltEcrImageResult) *string { return v.Region }).(pulumi.StringPtrOutput)
   143  }
   144  
   145  // Account ID containing the image. For example, `469771592824`.
   146  func (o GetPrebuiltEcrImageResultOutput) RegistryId() pulumi.StringOutput {
   147  	return o.ApplyT(func(v GetPrebuiltEcrImageResult) string { return v.RegistryId }).(pulumi.StringOutput)
   148  }
   149  
   150  // Docker image URL. For example, `341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4`.
   151  func (o GetPrebuiltEcrImageResultOutput) RegistryPath() pulumi.StringOutput {
   152  	return o.ApplyT(func(v GetPrebuiltEcrImageResult) string { return v.RegistryPath }).(pulumi.StringOutput)
   153  }
   154  
   155  func (o GetPrebuiltEcrImageResultOutput) RepositoryName() pulumi.StringOutput {
   156  	return o.ApplyT(func(v GetPrebuiltEcrImageResult) string { return v.RepositoryName }).(pulumi.StringOutput)
   157  }
   158  
   159  func init() {
   160  	pulumi.RegisterOutputType(GetPrebuiltEcrImageResultOutput{})
   161  }