virtualPypiRepository.go

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package artifactory

import (
	"context"
	"reflect"

	"github.com/pkg/errors"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// ## # Artifactory Virtual Pypi Repository Resource
//
// Provides an Artifactory virtual repository resource, but with specific pypi features. This should be preferred over the original
// one-size-fits-all `VirtualRepository`.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
// 	"github.com/pulumi/pulumi-artifactory/sdk/v2/go/artifactory"
// 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
// )
//
// func main() {
// 	pulumi.Run(func(ctx *pulumi.Context) error {
// 		_, err := artifactory.NewVirtualPypiRepository(ctx, "foo-pypi", &artifactory.VirtualPypiRepositoryArgs{
// 			Description:     pulumi.String("A test virtual repo"),
// 			ExcludesPattern: pulumi.String("com/google/**"),
// 			IncludesPattern: pulumi.String("com/jfrog/**,cloud/jfrog/**"),
// 			Key:             pulumi.String("foo-pypi"),
// 			Notes:           pulumi.String("Internal description"),
// 			Repositories:    pulumi.StringArray{},
// 		})
// 		if err != nil {
// 			return err
// 		}
// 		return nil
// 	})
// }
// ```
//
// ## Import
//
// Virtual repositories can be imported using their name, e.g.
//
// ```sh
//  $ pulumi import artifactory:index/virtualPypiRepository:VirtualPypiRepository foo foo
// ```
type VirtualPypiRepository struct {
	pulumi.CustomResourceState

	// Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by
	// another Artifactory instance.
	ArtifactoryRequestsCanRetrieveRemoteArtifacts pulumi.BoolPtrOutput `pulumi:"artifactoryRequestsCanRetrieveRemoteArtifacts"`
	// Default repository to deploy artifacts.
	DefaultDeploymentRepo pulumi.StringPtrOutput `pulumi:"defaultDeploymentRepo"`
	// A free text field that describes the content and purpose of the repository. If you choose to insert a link into this
	// field, clicking the link will prompt the user to confirm that they might be redirected to a new domain.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no
	// artifacts are excluded.
	ExcludesPattern pulumi.StringPtrOutput `pulumi:"excludesPattern"`
	// List of artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only
	// artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
	IncludesPattern pulumi.StringPtrOutput `pulumi:"includesPattern"`
	// The Repository Key. A mandatory identifier for the repository and must be unique. It cannot begin with a number or
	// contain spaces or special characters. For local repositories, we recommend using a '-local' suffix (e.g.
	// 'libs-release-local').
	Key pulumi.StringOutput `pulumi:"key"`
	// A free text field to add additional notes about the repository. These are only visible to the administrator.
	Notes pulumi.StringPtrOutput `pulumi:"notes"`
	// The Package Type. This must be specified when the repository is created, and once set, cannot be changed.
	PackageType pulumi.StringOutput `pulumi:"packageType"`
	// Project environment for assigning this repository to. Allow values: "DEV" or "PROD"
	ProjectEnvironments pulumi.StringArrayOutput `pulumi:"projectEnvironments"`
	// Project key for assigning this repository to. Must be 3 - 10 lowercase alphanumeric characters. When assigning
	// repository to a project, repository key must be prefixed with project key, separated by a dash.
	ProjectKey pulumi.StringPtrOutput `pulumi:"projectKey"`
	// Repository layout key for the local repository
	RepoLayoutRef pulumi.StringPtrOutput `pulumi:"repoLayoutRef"`
	// The effective list of actual repositories included in this virtual repository.
	Repositories pulumi.StringArrayOutput `pulumi:"repositories"`
	// This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated
	// repositories. A value of 0 indicates no caching.
	RetrievalCachePeriodSeconds pulumi.IntPtrOutput `pulumi:"retrievalCachePeriodSeconds"`
}

// NewVirtualPypiRepository registers a new resource with the given unique name, arguments, and options.
func NewVirtualPypiRepository(ctx *pulumi.Context,
	name string, args *VirtualPypiRepositoryArgs, opts ...pulumi.ResourceOption) (*VirtualPypiRepository, error) {
	if args == nil {
		return nil, errors.New("missing one or more required arguments")
	}

	if args.Key == nil {
		return nil, errors.New("invalid value for required argument 'Key'")
	}
	var resource VirtualPypiRepository
	err := ctx.RegisterResource("artifactory:index/virtualPypiRepository:VirtualPypiRepository", name, args, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// GetVirtualPypiRepository gets an existing VirtualPypiRepository resource's state with the given name, ID, and optional
// state properties that are used to uniquely qualify the lookup (nil if not required).
func GetVirtualPypiRepository(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *VirtualPypiRepositoryState, opts ...pulumi.ResourceOption) (*VirtualPypiRepository, error) {
	var resource VirtualPypiRepository
	err := ctx.ReadResource("artifactory:index/virtualPypiRepository:VirtualPypiRepository", name, id, state, &resource, opts...)
	if err != nil {
		return nil, err
	}
	return &resource, nil
}

// Input properties used for looking up and filtering VirtualPypiRepository resources.
type virtualPypiRepositoryState struct {
	// Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by
	// another Artifactory instance.
	ArtifactoryRequestsCanRetrieveRemoteArtifacts *bool `pulumi:"artifactoryRequestsCanRetrieveRemoteArtifacts"`
	// Default repository to deploy artifacts.
	DefaultDeploymentRepo *string `pulumi:"defaultDeploymentRepo"`
	// A free text field that describes the content and purpose of the repository. If you choose to insert a link into this
	// field, clicking the link will prompt the user to confirm that they might be redirected to a new domain.
	Description *string `pulumi:"description"`
	// List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no
	// artifacts are excluded.
	ExcludesPattern *string `pulumi:"excludesPattern"`
	// List of artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only
	// artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
	IncludesPattern *string `pulumi:"includesPattern"`
	// The Repository Key. A mandatory identifier for the repository and must be unique. It cannot begin with a number or
	// contain spaces or special characters. For local repositories, we recommend using a '-local' suffix (e.g.
	// 'libs-release-local').
	Key *string `pulumi:"key"`
	// A free text field to add additional notes about the repository. These are only visible to the administrator.
	Notes *string `pulumi:"notes"`
	// The Package Type. This must be specified when the repository is created, and once set, cannot be changed.
	PackageType *string `pulumi:"packageType"`
	// Project environment for assigning this repository to. Allow values: "DEV" or "PROD"
	ProjectEnvironments []string `pulumi:"projectEnvironments"`
	// Project key for assigning this repository to. Must be 3 - 10 lowercase alphanumeric characters. When assigning
	// repository to a project, repository key must be prefixed with project key, separated by a dash.
	ProjectKey *string `pulumi:"projectKey"`
	// Repository layout key for the local repository
	RepoLayoutRef *string `pulumi:"repoLayoutRef"`
	// The effective list of actual repositories included in this virtual repository.
	Repositories []string `pulumi:"repositories"`
	// This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated
	// repositories. A value of 0 indicates no caching.
	RetrievalCachePeriodSeconds *int `pulumi:"retrievalCachePeriodSeconds"`
}

type VirtualPypiRepositoryState struct {
	// Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by
	// another Artifactory instance.
	ArtifactoryRequestsCanRetrieveRemoteArtifacts pulumi.BoolPtrInput
	// Default repository to deploy artifacts.
	DefaultDeploymentRepo pulumi.StringPtrInput
	// A free text field that describes the content and purpose of the repository. If you choose to insert a link into this
	// field, clicking the link will prompt the user to confirm that they might be redirected to a new domain.
	Description pulumi.StringPtrInput
	// List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no
	// artifacts are excluded.
	ExcludesPattern pulumi.StringPtrInput
	// List of artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only
	// artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
	IncludesPattern pulumi.StringPtrInput
	// The Repository Key. A mandatory identifier for the repository and must be unique. It cannot begin with a number or
	// contain spaces or special characters. For local repositories, we recommend using a '-local' suffix (e.g.
	// 'libs-release-local').
	Key pulumi.StringPtrInput
	// A free text field to add additional notes about the repository. These are only visible to the administrator.
	Notes pulumi.StringPtrInput
	// The Package Type. This must be specified when the repository is created, and once set, cannot be changed.
	PackageType pulumi.StringPtrInput
	// Project environment for assigning this repository to. Allow values: "DEV" or "PROD"
	ProjectEnvironments pulumi.StringArrayInput
	// Project key for assigning this repository to. Must be 3 - 10 lowercase alphanumeric characters. When assigning
	// repository to a project, repository key must be prefixed with project key, separated by a dash.
	ProjectKey pulumi.StringPtrInput
	// Repository layout key for the local repository
	RepoLayoutRef pulumi.StringPtrInput
	// The effective list of actual repositories included in this virtual repository.
	Repositories pulumi.StringArrayInput
	// This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated
	// repositories. A value of 0 indicates no caching.
	RetrievalCachePeriodSeconds pulumi.IntPtrInput
}

func (VirtualPypiRepositoryState) ElementType() reflect.Type {
	return reflect.TypeOf((*virtualPypiRepositoryState)(nil)).Elem()
}

type virtualPypiRepositoryArgs struct {
	// Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by
	// another Artifactory instance.
	ArtifactoryRequestsCanRetrieveRemoteArtifacts *bool `pulumi:"artifactoryRequestsCanRetrieveRemoteArtifacts"`
	// Default repository to deploy artifacts.
	DefaultDeploymentRepo *string `pulumi:"defaultDeploymentRepo"`
	// A free text field that describes the content and purpose of the repository. If you choose to insert a link into this
	// field, clicking the link will prompt the user to confirm that they might be redirected to a new domain.
	Description *string `pulumi:"description"`
	// List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no
	// artifacts are excluded.
	ExcludesPattern *string `pulumi:"excludesPattern"`
	// List of artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only
	// artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
	IncludesPattern *string `pulumi:"includesPattern"`
	// The Repository Key. A mandatory identifier for the repository and must be unique. It cannot begin with a number or
	// contain spaces or special characters. For local repositories, we recommend using a '-local' suffix (e.g.
	// 'libs-release-local').
	Key string `pulumi:"key"`
	// A free text field to add additional notes about the repository. These are only visible to the administrator.
	Notes *string `pulumi:"notes"`
	// Project environment for assigning this repository to. Allow values: "DEV" or "PROD"
	ProjectEnvironments []string `pulumi:"projectEnvironments"`
	// Project key for assigning this repository to. Must be 3 - 10 lowercase alphanumeric characters. When assigning
	// repository to a project, repository key must be prefixed with project key, separated by a dash.
	ProjectKey *string `pulumi:"projectKey"`
	// Repository layout key for the local repository
	RepoLayoutRef *string `pulumi:"repoLayoutRef"`
	// The effective list of actual repositories included in this virtual repository.
	Repositories []string `pulumi:"repositories"`
	// This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated
	// repositories. A value of 0 indicates no caching.
	RetrievalCachePeriodSeconds *int `pulumi:"retrievalCachePeriodSeconds"`
}

// The set of arguments for constructing a VirtualPypiRepository resource.
type VirtualPypiRepositoryArgs struct {
	// Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by
	// another Artifactory instance.
	ArtifactoryRequestsCanRetrieveRemoteArtifacts pulumi.BoolPtrInput
	// Default repository to deploy artifacts.
	DefaultDeploymentRepo pulumi.StringPtrInput
	// A free text field that describes the content and purpose of the repository. If you choose to insert a link into this
	// field, clicking the link will prompt the user to confirm that they might be redirected to a new domain.
	Description pulumi.StringPtrInput
	// List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no
	// artifacts are excluded.
	ExcludesPattern pulumi.StringPtrInput
	// List of artifact patterns to include when evaluating artifact requests in the form of x/y/**/z/*. When used, only
	// artifacts matching one of the include patterns are served. By default, all artifacts are included (**/*).
	IncludesPattern pulumi.StringPtrInput
	// The Repository Key. A mandatory identifier for the repository and must be unique. It cannot begin with a number or
	// contain spaces or special characters. For local repositories, we recommend using a '-local' suffix (e.g.
	// 'libs-release-local').
	Key pulumi.StringInput
	// A free text field to add additional notes about the repository. These are only visible to the administrator.
	Notes pulumi.StringPtrInput
	// Project environment for assigning this repository to. Allow values: "DEV" or "PROD"
	ProjectEnvironments pulumi.StringArrayInput
	// Project key for assigning this repository to. Must be 3 - 10 lowercase alphanumeric characters. When assigning
	// repository to a project, repository key must be prefixed with project key, separated by a dash.
	ProjectKey pulumi.StringPtrInput
	// Repository layout key for the local repository
	RepoLayoutRef pulumi.StringPtrInput
	// The effective list of actual repositories included in this virtual repository.
	Repositories pulumi.StringArrayInput
	// This value refers to the number of seconds to cache metadata files before checking for newer versions on aggregated
	// repositories. A value of 0 indicates no caching.
	RetrievalCachePeriodSeconds pulumi.IntPtrInput
}

func (VirtualPypiRepositoryArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*virtualPypiRepositoryArgs)(nil)).Elem()
}

type VirtualPypiRepositoryInput interface {
	pulumi.Input

	ToVirtualPypiRepositoryOutput() VirtualPypiRepositoryOutput
	ToVirtualPypiRepositoryOutputWithContext(ctx context.Context) VirtualPypiRepositoryOutput
}

func (*VirtualPypiRepository) ElementType() reflect.Type {
	return reflect.TypeOf((**VirtualPypiRepository)(nil)).Elem()
}

func (i *VirtualPypiRepository) ToVirtualPypiRepositoryOutput() VirtualPypiRepositoryOutput {
	return i.ToVirtualPypiRepositoryOutputWithContext(context.Background())
}

func (i *VirtualPypiRepository) ToVirtualPypiRepositoryOutputWithContext(ctx context.Context) VirtualPypiRepositoryOutput {
	return pulumi.ToOutputWithContext(ctx, i).(VirtualPypiRepositoryOutput)
}

// VirtualPypiRepositoryArrayInput is an input type that accepts VirtualPypiRepositoryArray and VirtualPypiRepositoryArrayOutput values.
// You can construct a concrete instance of `VirtualPypiRepositoryArrayInput` via:
//
//          VirtualPypiRepositoryArray{ VirtualPypiRepositoryArgs{...} }
type VirtualPypiRepositoryArrayInput interface {
	pulumi.Input

	ToVirtualPypiRepositoryArrayOutput() VirtualPypiRepositoryArrayOutput
	ToVirtualPypiRepositoryArrayOutputWithContext(context.Context) VirtualPypiRepositoryArrayOutput
}

type VirtualPypiRepositoryArray []VirtualPypiRepositoryInput

func (VirtualPypiRepositoryArray) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*VirtualPypiRepository)(nil)).Elem()
}

func (i VirtualPypiRepositoryArray) ToVirtualPypiRepositoryArrayOutput() VirtualPypiRepositoryArrayOutput {
	return i.ToVirtualPypiRepositoryArrayOutputWithContext(context.Background())
}

func (i VirtualPypiRepositoryArray) ToVirtualPypiRepositoryArrayOutputWithContext(ctx context.Context) VirtualPypiRepositoryArrayOutput {
	return pulumi.ToOutputWithContext(ctx, i).(VirtualPypiRepositoryArrayOutput)
}

// VirtualPypiRepositoryMapInput is an input type that accepts VirtualPypiRepositoryMap and VirtualPypiRepositoryMapOutput values.
// You can construct a concrete instance of `VirtualPypiRepositoryMapInput` via:
//
//          VirtualPypiRepositoryMap{ "key": VirtualPypiRepositoryArgs{...} }
type VirtualPypiRepositoryMapInput interface {
	pulumi.Input

	ToVirtualPypiRepositoryMapOutput() VirtualPypiRepositoryMapOutput
	ToVirtualPypiRepositoryMapOutputWithContext(context.Context) VirtualPypiRepositoryMapOutput
}

type VirtualPypiRepositoryMap map[string]VirtualPypiRepositoryInput

func (VirtualPypiRepositoryMap) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*VirtualPypiRepository)(nil)).Elem()
}

func (i VirtualPypiRepositoryMap) ToVirtualPypiRepositoryMapOutput() VirtualPypiRepositoryMapOutput {
	return i.ToVirtualPypiRepositoryMapOutputWithContext(context.Background())
}

func (i VirtualPypiRepositoryMap) ToVirtualPypiRepositoryMapOutputWithContext(ctx context.Context) VirtualPypiRepositoryMapOutput {
	return pulumi.ToOutputWithContext(ctx, i).(VirtualPypiRepositoryMapOutput)
}

type VirtualPypiRepositoryOutput struct{ *pulumi.OutputState }

func (VirtualPypiRepositoryOutput) ElementType() reflect.Type {
	return reflect.TypeOf((**VirtualPypiRepository)(nil)).Elem()
}

func (o VirtualPypiRepositoryOutput) ToVirtualPypiRepositoryOutput() VirtualPypiRepositoryOutput {
	return o
}

func (o VirtualPypiRepositoryOutput) ToVirtualPypiRepositoryOutputWithContext(ctx context.Context) VirtualPypiRepositoryOutput {
	return o
}

type VirtualPypiRepositoryArrayOutput struct{ *pulumi.OutputState }

func (VirtualPypiRepositoryArrayOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*[]*VirtualPypiRepository)(nil)).Elem()
}

func (o VirtualPypiRepositoryArrayOutput) ToVirtualPypiRepositoryArrayOutput() VirtualPypiRepositoryArrayOutput {
	return o
}

func (o VirtualPypiRepositoryArrayOutput) ToVirtualPypiRepositoryArrayOutputWithContext(ctx context.Context) VirtualPypiRepositoryArrayOutput {
	return o
}

func (o VirtualPypiRepositoryArrayOutput) Index(i pulumi.IntInput) VirtualPypiRepositoryOutput {
	return pulumi.All(o, i).ApplyT(func(vs []interface{}) *VirtualPypiRepository {
		return vs[0].([]*VirtualPypiRepository)[vs[1].(int)]
	}).(VirtualPypiRepositoryOutput)
}

type VirtualPypiRepositoryMapOutput struct{ *pulumi.OutputState }

func (VirtualPypiRepositoryMapOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*map[string]*VirtualPypiRepository)(nil)).Elem()
}

func (o VirtualPypiRepositoryMapOutput) ToVirtualPypiRepositoryMapOutput() VirtualPypiRepositoryMapOutput {
	return o
}

func (o VirtualPypiRepositoryMapOutput) ToVirtualPypiRepositoryMapOutputWithContext(ctx context.Context) VirtualPypiRepositoryMapOutput {
	return o
}

func (o VirtualPypiRepositoryMapOutput) MapIndex(k pulumi.StringInput) VirtualPypiRepositoryOutput {
	return pulumi.All(o, k).ApplyT(func(vs []interface{}) *VirtualPypiRepository {
		return vs[0].(map[string]*VirtualPypiRepository)[vs[1].(string)]
	}).(VirtualPypiRepositoryOutput)
}

func init() {
	pulumi.RegisterInputType(reflect.TypeOf((*VirtualPypiRepositoryInput)(nil)).Elem(), &VirtualPypiRepository{})
	pulumi.RegisterInputType(reflect.TypeOf((*VirtualPypiRepositoryArrayInput)(nil)).Elem(), VirtualPypiRepositoryArray{})
	pulumi.RegisterInputType(reflect.TypeOf((*VirtualPypiRepositoryMapInput)(nil)).Elem(), VirtualPypiRepositoryMap{})
	pulumi.RegisterOutputType(VirtualPypiRepositoryOutput{})
	pulumi.RegisterOutputType(VirtualPypiRepositoryArrayOutput{})
	pulumi.RegisterOutputType(VirtualPypiRepositoryMapOutput{})
}