Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. VirtualSwiftRepository
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-artifactory

artifactory.VirtualSwiftRepository

Explore with Pulumi AI

artifactory logo
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-artifactory

    Creates a virtual Swift repository. Official documentation can be found here.

    Create VirtualSwiftRepository Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualSwiftRepository(name: string, args: VirtualSwiftRepositoryArgs, opts?: CustomResourceOptions);
    @overload
def VirtualSwiftRepository(resource_name: str,
                           args: VirtualSwiftRepositoryArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def VirtualSwiftRepository(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           key: Optional[str] = None,
                           artifactory_requests_can_retrieve_remote_artifacts: Optional[bool] = None,
                           default_deployment_repo: Optional[str] = None,
                           description: Optional[str] = None,
                           excludes_pattern: Optional[str] = None,
                           includes_pattern: Optional[str] = None,
                           notes: Optional[str] = None,
                           project_environments: Optional[Sequence[str]] = None,
                           project_key: Optional[str] = None,
                           repo_layout_ref: Optional[str] = None,
                           repositories: Optional[Sequence[str]] = None)
    func NewVirtualSwiftRepository(ctx *Context, name string, args VirtualSwiftRepositoryArgs, opts ...ResourceOption) (*VirtualSwiftRepository, error)
    public VirtualSwiftRepository(string name, VirtualSwiftRepositoryArgs args, CustomResourceOptions? opts = null)
    public VirtualSwiftRepository(String name, VirtualSwiftRepositoryArgs args)
public VirtualSwiftRepository(String name, VirtualSwiftRepositoryArgs args, CustomResourceOptions options)

    type: artifactory:VirtualSwiftRepository
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualSwiftRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualSwiftRepositoryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualSwiftRepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualSwiftRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualSwiftRepositoryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualSwiftRepositoryResource = new Artifactory.VirtualSwiftRepository("virtualSwiftRepositoryResource", new()
{
    Key = "string",
    ArtifactoryRequestsCanRetrieveRemoteArtifacts = false,
    DefaultDeploymentRepo = "string",
    Description = "string",
    ExcludesPattern = "string",
    IncludesPattern = "string",
    Notes = "string",
    ProjectEnvironments = new[]
    {
        "string",
    },
    ProjectKey = "string",
    RepoLayoutRef = "string",
    Repositories = new[]
    {
        "string",
    },
});

    example, err := artifactory.NewVirtualSwiftRepository(ctx, "virtualSwiftRepositoryResource", &artifactory.VirtualSwiftRepositoryArgs{
	Key: pulumi.String("string"),
	ArtifactoryRequestsCanRetrieveRemoteArtifacts: pulumi.Bool(false),
	DefaultDeploymentRepo:                         pulumi.String("string"),
	Description:                                   pulumi.String("string"),
	ExcludesPattern:                               pulumi.String("string"),
	IncludesPattern:                               pulumi.String("string"),
	Notes:                                         pulumi.String("string"),
	ProjectEnvironments: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProjectKey:    pulumi.String("string"),
	RepoLayoutRef: pulumi.String("string"),
	Repositories: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var virtualSwiftRepositoryResource = new VirtualSwiftRepository("virtualSwiftRepositoryResource", VirtualSwiftRepositoryArgs.builder()
    .key("string")
    .artifactoryRequestsCanRetrieveRemoteArtifacts(false)
    .defaultDeploymentRepo("string")
    .description("string")
    .excludesPattern("string")
    .includesPattern("string")
    .notes("string")
    .projectEnvironments("string")
    .projectKey("string")
    .repoLayoutRef("string")
    .repositories("string")
    .build());

    virtual_swift_repository_resource = artifactory.VirtualSwiftRepository("virtualSwiftRepositoryResource",
    key="string",
    artifactory_requests_can_retrieve_remote_artifacts=False,
    default_deployment_repo="string",
    description="string",
    excludes_pattern="string",
    includes_pattern="string",
    notes="string",
    project_environments=["string"],
    project_key="string",
    repo_layout_ref="string",
    repositories=["string"])

    const virtualSwiftRepositoryResource = new artifactory.VirtualSwiftRepository("virtualSwiftRepositoryResource", {
    key: "string",
    artifactoryRequestsCanRetrieveRemoteArtifacts: false,
    defaultDeploymentRepo: "string",
    description: "string",
    excludesPattern: "string",
    includesPattern: "string",
    notes: "string",
    projectEnvironments: ["string"],
    projectKey: "string",
    repoLayoutRef: "string",
    repositories: ["string"],
});

    type: artifactory:VirtualSwiftRepository
properties:
    artifactoryRequestsCanRetrieveRemoteArtifacts: false
    defaultDeploymentRepo: string
    description: string
    excludesPattern: string
    includesPattern: string
    key: string
    notes: string
    projectEnvironments:
        - string
    projectKey: string
    repoLayoutRef: string
    repositories:
        - string

    VirtualSwiftRepository Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VirtualSwiftRepository resource accepts the following input properties:

    Key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated 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 (**/*).
    Notes string
    Internal description.
    ProjectEnvironments List<string>
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories List<string>
    The effective list of actual repositories included in this virtual repository.
    Key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated 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 (**/*).
    Notes string
    Internal description.
    ProjectEnvironments []string
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories []string
    The effective list of actual repositories included in this virtual repository.
    key String
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated 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 (**/*).
    notes String
    Internal description.
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.
    key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo string
    Default repository to deploy artifacts.
    description string
    Public description.
    excludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern string
    List of comma-separated 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 (**/*).
    notes string
    Internal description.
    projectEnvironments string[]
    projectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef string
    Repository layout key for the virtual repository
    repositories string[]
    The effective list of actual repositories included in this virtual repository.
    key str
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactory_requests_can_retrieve_remote_artifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    default_deployment_repo str
    Default repository to deploy artifacts.
    description str
    Public description.
    excludes_pattern str
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includes_pattern str
    List of comma-separated 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 (**/*).
    notes str
    Internal description.
    project_environments Sequence[str]
    project_key str
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repo_layout_ref str
    Repository layout key for the virtual repository
    repositories Sequence[str]
    The effective list of actual repositories included in this virtual repository.
    key String
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated 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 (**/*).
    notes String
    Internal description.
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualSwiftRepository resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PackageType string
    Id string
    The provider-assigned unique ID for this managed resource.
    PackageType string
    id String
    The provider-assigned unique ID for this managed resource.
    packageType String
    id string
    The provider-assigned unique ID for this managed resource.
    packageType string
    id str
    The provider-assigned unique ID for this managed resource.
    package_type str
    id String
    The provider-assigned unique ID for this managed resource.
    packageType String

    Look up Existing VirtualSwiftRepository Resource

    Get an existing VirtualSwiftRepository resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VirtualSwiftRepositoryState, opts?: CustomResourceOptions): VirtualSwiftRepository
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        artifactory_requests_can_retrieve_remote_artifacts: Optional[bool] = None,
        default_deployment_repo: Optional[str] = None,
        description: Optional[str] = None,
        excludes_pattern: Optional[str] = None,
        includes_pattern: Optional[str] = None,
        key: Optional[str] = None,
        notes: Optional[str] = None,
        package_type: Optional[str] = None,
        project_environments: Optional[Sequence[str]] = None,
        project_key: Optional[str] = None,
        repo_layout_ref: Optional[str] = None,
        repositories: Optional[Sequence[str]] = None) -> VirtualSwiftRepository
    func GetVirtualSwiftRepository(ctx *Context, name string, id IDInput, state *VirtualSwiftRepositoryState, opts ...ResourceOption) (*VirtualSwiftRepository, error)
    public static VirtualSwiftRepository Get(string name, Input<string> id, VirtualSwiftRepositoryState? state, CustomResourceOptions? opts = null)
    public static VirtualSwiftRepository get(String name, Output<String> id, VirtualSwiftRepositoryState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated 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 (**/*).
    Key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    Notes string
    Internal description.
    PackageType string
    ProjectEnvironments List<string>
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories List<string>
    The effective list of actual repositories included in this virtual repository.
    ArtifactoryRequestsCanRetrieveRemoteArtifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    DefaultDeploymentRepo string
    Default repository to deploy artifacts.
    Description string
    Public description.
    ExcludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    IncludesPattern string
    List of comma-separated 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 (**/*).
    Key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    Notes string
    Internal description.
    PackageType string
    ProjectEnvironments []string
    ProjectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    RepoLayoutRef string
    Repository layout key for the virtual repository
    Repositories []string
    The effective list of actual repositories included in this virtual repository.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated 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 (**/*).
    key String
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    notes String
    Internal description.
    packageType String
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.
    artifactoryRequestsCanRetrieveRemoteArtifacts boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo string
    Default repository to deploy artifacts.
    description string
    Public description.
    excludesPattern string
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern string
    List of comma-separated 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 (**/*).
    key string
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    notes string
    Internal description.
    packageType string
    projectEnvironments string[]
    projectKey string
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef string
    Repository layout key for the virtual repository
    repositories string[]
    The effective list of actual repositories included in this virtual repository.
    artifactory_requests_can_retrieve_remote_artifacts bool
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    default_deployment_repo str
    Default repository to deploy artifacts.
    description str
    Public description.
    excludes_pattern str
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includes_pattern str
    List of comma-separated 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 (**/*).
    key str
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    notes str
    Internal description.
    package_type str
    project_environments Sequence[str]
    project_key str
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repo_layout_ref str
    Repository layout key for the virtual repository
    repositories Sequence[str]
    The effective list of actual repositories included in this virtual repository.
    artifactoryRequestsCanRetrieveRemoteArtifacts Boolean
    Whether the virtual repository should search through remote repositories when trying to resolve an artifact requested by another Artifactory instance.
    defaultDeploymentRepo String
    Default repository to deploy artifacts.
    description String
    Public description.
    excludesPattern String
    List of artifact patterns to exclude when evaluating artifact requests, in the form of x/y/**/z/*.By default no artifacts are excluded.
    includesPattern String
    List of comma-separated 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 (**/*).
    key String
    A mandatory identifier for the repository that must be unique. It cannot begin with a number or contain spaces or special characters.
    notes String
    Internal description.
    packageType String
    projectEnvironments List<String>
    projectKey String
    Project key for assigning this repository to. Must be 2 - 32 lowercase alphanumeric and hyphen characters. When assigning repository to a project, repository key must be prefixed with project key, separated by a dash.
    repoLayoutRef String
    Repository layout key for the virtual repository
    repositories List<String>
    The effective list of actual repositories included in this virtual repository.

    Import

    Virtual repositories can be imported using their name, e.g.

    $ pulumi import artifactory:index/virtualSwiftRepository:VirtualSwiftRepository foo-swift foo-swift

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    artifactory pulumi/pulumi-artifactory
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the artifactory Terraform Provider.
    artifactory logo
    artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-artifactory