artifactory.FederatedHelmociRepository
Explore with Pulumi AI
Creates a federated Helm OCI repository.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as artifactory from "@pulumi/artifactory";
const my_helmoci_federated = new artifactory.FederatedHelmociRepository("my-helmoci-federated", {
key: "my-helmoci-federated",
members: [
{
url: "http://tempurl.org/artifactory/my-helmoci-federated",
enabled: true,
},
{
url: "http://tempurl2.org/artifactory/my-helmoci-federated-2",
enabled: true,
},
],
});
import pulumi
import pulumi_artifactory as artifactory
my_helmoci_federated = artifactory.FederatedHelmociRepository("my-helmoci-federated",
key="my-helmoci-federated",
members=[
{
"url": "http://tempurl.org/artifactory/my-helmoci-federated",
"enabled": True,
},
{
"url": "http://tempurl2.org/artifactory/my-helmoci-federated-2",
"enabled": True,
},
])
package main
import (
"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := artifactory.NewFederatedHelmociRepository(ctx, "my-helmoci-federated", &artifactory.FederatedHelmociRepositoryArgs{
Key: pulumi.String("my-helmoci-federated"),
Members: artifactory.FederatedHelmociRepositoryMemberArray{
&artifactory.FederatedHelmociRepositoryMemberArgs{
Url: pulumi.String("http://tempurl.org/artifactory/my-helmoci-federated"),
Enabled: pulumi.Bool(true),
},
&artifactory.FederatedHelmociRepositoryMemberArgs{
Url: pulumi.String("http://tempurl2.org/artifactory/my-helmoci-federated-2"),
Enabled: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;
return await Deployment.RunAsync(() =>
{
var my_helmoci_federated = new Artifactory.FederatedHelmociRepository("my-helmoci-federated", new()
{
Key = "my-helmoci-federated",
Members = new[]
{
new Artifactory.Inputs.FederatedHelmociRepositoryMemberArgs
{
Url = "http://tempurl.org/artifactory/my-helmoci-federated",
Enabled = true,
},
new Artifactory.Inputs.FederatedHelmociRepositoryMemberArgs
{
Url = "http://tempurl2.org/artifactory/my-helmoci-federated-2",
Enabled = true,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.FederatedHelmociRepository;
import com.pulumi.artifactory.FederatedHelmociRepositoryArgs;
import com.pulumi.artifactory.inputs.FederatedHelmociRepositoryMemberArgs;
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) {
var my_helmoci_federated = new FederatedHelmociRepository("my-helmoci-federated", FederatedHelmociRepositoryArgs.builder()
.key("my-helmoci-federated")
.members(
FederatedHelmociRepositoryMemberArgs.builder()
.url("http://tempurl.org/artifactory/my-helmoci-federated")
.enabled(true)
.build(),
FederatedHelmociRepositoryMemberArgs.builder()
.url("http://tempurl2.org/artifactory/my-helmoci-federated-2")
.enabled(true)
.build())
.build());
}
}
resources:
my-helmoci-federated:
type: artifactory:FederatedHelmociRepository
properties:
key: my-helmoci-federated
members:
- url: http://tempurl.org/artifactory/my-helmoci-federated
enabled: true
- url: http://tempurl2.org/artifactory/my-helmoci-federated-2
enabled: true
Create FederatedHelmociRepository Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FederatedHelmociRepository(name: string, args: FederatedHelmociRepositoryArgs, opts?: CustomResourceOptions);
@overload
def FederatedHelmociRepository(resource_name: str,
args: FederatedHelmociRepositoryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FederatedHelmociRepository(resource_name: str,
opts: Optional[ResourceOptions] = None,
key: Optional[str] = None,
members: Optional[Sequence[FederatedHelmociRepositoryMemberArgs]] = None,
max_unique_tags: Optional[int] = None,
blacked_out: Optional[bool] = None,
description: Optional[str] = None,
disable_proxy: Optional[bool] = None,
download_direct: Optional[bool] = None,
excludes_pattern: Optional[str] = None,
includes_pattern: Optional[str] = None,
cdn_redirect: Optional[bool] = None,
archive_browsing_enabled: Optional[bool] = None,
cleanup_on_delete: Optional[bool] = None,
notes: Optional[str] = None,
priority_resolution: Optional[bool] = None,
project_environments: Optional[Sequence[str]] = None,
project_key: Optional[str] = None,
property_sets: Optional[Sequence[str]] = None,
proxy: Optional[str] = None,
repo_layout_ref: Optional[str] = None,
tag_retention: Optional[int] = None,
xray_index: Optional[bool] = None)
func NewFederatedHelmociRepository(ctx *Context, name string, args FederatedHelmociRepositoryArgs, opts ...ResourceOption) (*FederatedHelmociRepository, error)
public FederatedHelmociRepository(string name, FederatedHelmociRepositoryArgs args, CustomResourceOptions? opts = null)
public FederatedHelmociRepository(String name, FederatedHelmociRepositoryArgs args)
public FederatedHelmociRepository(String name, FederatedHelmociRepositoryArgs args, CustomResourceOptions options)
type: artifactory:FederatedHelmociRepository
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 FederatedHelmociRepositoryArgs
- 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 FederatedHelmociRepositoryArgs
- 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 FederatedHelmociRepositoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FederatedHelmociRepositoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FederatedHelmociRepositoryArgs
- 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 federatedHelmociRepositoryResource = new Artifactory.FederatedHelmociRepository("federatedHelmociRepositoryResource", new()
{
Key = "string",
Members = new[]
{
new Artifactory.Inputs.FederatedHelmociRepositoryMemberArgs
{
Enabled = false,
Url = "string",
AccessToken = "string",
},
},
MaxUniqueTags = 0,
BlackedOut = false,
Description = "string",
DisableProxy = false,
DownloadDirect = false,
ExcludesPattern = "string",
IncludesPattern = "string",
CdnRedirect = false,
ArchiveBrowsingEnabled = false,
CleanupOnDelete = false,
Notes = "string",
PriorityResolution = false,
ProjectEnvironments = new[]
{
"string",
},
ProjectKey = "string",
PropertySets = new[]
{
"string",
},
Proxy = "string",
RepoLayoutRef = "string",
TagRetention = 0,
XrayIndex = false,
});
example, err := artifactory.NewFederatedHelmociRepository(ctx, "federatedHelmociRepositoryResource", &artifactory.FederatedHelmociRepositoryArgs{
Key: pulumi.String("string"),
Members: artifactory.FederatedHelmociRepositoryMemberArray{
&artifactory.FederatedHelmociRepositoryMemberArgs{
Enabled: pulumi.Bool(false),
Url: pulumi.String("string"),
AccessToken: pulumi.String("string"),
},
},
MaxUniqueTags: pulumi.Int(0),
BlackedOut: pulumi.Bool(false),
Description: pulumi.String("string"),
DisableProxy: pulumi.Bool(false),
DownloadDirect: pulumi.Bool(false),
ExcludesPattern: pulumi.String("string"),
IncludesPattern: pulumi.String("string"),
CdnRedirect: pulumi.Bool(false),
ArchiveBrowsingEnabled: pulumi.Bool(false),
CleanupOnDelete: pulumi.Bool(false),
Notes: pulumi.String("string"),
PriorityResolution: pulumi.Bool(false),
ProjectEnvironments: pulumi.StringArray{
pulumi.String("string"),
},
ProjectKey: pulumi.String("string"),
PropertySets: pulumi.StringArray{
pulumi.String("string"),
},
Proxy: pulumi.String("string"),
RepoLayoutRef: pulumi.String("string"),
TagRetention: pulumi.Int(0),
XrayIndex: pulumi.Bool(false),
})
var federatedHelmociRepositoryResource = new FederatedHelmociRepository("federatedHelmociRepositoryResource", FederatedHelmociRepositoryArgs.builder()
.key("string")
.members(FederatedHelmociRepositoryMemberArgs.builder()
.enabled(false)
.url("string")
.accessToken("string")
.build())
.maxUniqueTags(0)
.blackedOut(false)
.description("string")
.disableProxy(false)
.downloadDirect(false)
.excludesPattern("string")
.includesPattern("string")
.cdnRedirect(false)
.archiveBrowsingEnabled(false)
.cleanupOnDelete(false)
.notes("string")
.priorityResolution(false)
.projectEnvironments("string")
.projectKey("string")
.propertySets("string")
.proxy("string")
.repoLayoutRef("string")
.tagRetention(0)
.xrayIndex(false)
.build());
federated_helmoci_repository_resource = artifactory.FederatedHelmociRepository("federatedHelmociRepositoryResource",
key="string",
members=[{
"enabled": False,
"url": "string",
"access_token": "string",
}],
max_unique_tags=0,
blacked_out=False,
description="string",
disable_proxy=False,
download_direct=False,
excludes_pattern="string",
includes_pattern="string",
cdn_redirect=False,
archive_browsing_enabled=False,
cleanup_on_delete=False,
notes="string",
priority_resolution=False,
project_environments=["string"],
project_key="string",
property_sets=["string"],
proxy="string",
repo_layout_ref="string",
tag_retention=0,
xray_index=False)
const federatedHelmociRepositoryResource = new artifactory.FederatedHelmociRepository("federatedHelmociRepositoryResource", {
key: "string",
members: [{
enabled: false,
url: "string",
accessToken: "string",
}],
maxUniqueTags: 0,
blackedOut: false,
description: "string",
disableProxy: false,
downloadDirect: false,
excludesPattern: "string",
includesPattern: "string",
cdnRedirect: false,
archiveBrowsingEnabled: false,
cleanupOnDelete: false,
notes: "string",
priorityResolution: false,
projectEnvironments: ["string"],
projectKey: "string",
propertySets: ["string"],
proxy: "string",
repoLayoutRef: "string",
tagRetention: 0,
xrayIndex: false,
});
type: artifactory:FederatedHelmociRepository
properties:
archiveBrowsingEnabled: false
blackedOut: false
cdnRedirect: false
cleanupOnDelete: false
description: string
disableProxy: false
downloadDirect: false
excludesPattern: string
includesPattern: string
key: string
maxUniqueTags: 0
members:
- accessToken: string
enabled: false
url: string
notes: string
priorityResolution: false
projectEnvironments:
- string
projectKey: string
propertySets:
- string
proxy: string
repoLayoutRef: string
tagRetention: 0
xrayIndex: false
FederatedHelmociRepository 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 FederatedHelmociRepository resource accepts the following input properties:
- Key string
- the identity key of the repo.
- Members
List<Federated
Helmoci Repository Member> - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - Archive
Browsing boolEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- Blacked
Out bool - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- Cdn
Redirect bool - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- Cleanup
On boolDelete - Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - Download
Direct bool - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- Excludes
Pattern string - 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 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 (**/*
). - int
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- Notes string
- Internal description.
- Priority
Resolution bool - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- Project
Environments List<string> - Project
Key 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.
- Property
Sets List<string> - List of property set name
- Proxy string
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - Repo
Layout stringRef - Repository layout key for the federated repository
- Tag
Retention int - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- Xray
Index bool - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- Key string
- the identity key of the repo.
- Members
[]Federated
Helmoci Repository Member Args - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - Archive
Browsing boolEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- Blacked
Out bool - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- Cdn
Redirect bool - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- Cleanup
On boolDelete - Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - Download
Direct bool - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- Excludes
Pattern string - 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 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 (**/*
). - int
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- Notes string
- Internal description.
- Priority
Resolution bool - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- Project
Environments []string - Project
Key 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.
- Property
Sets []string - List of property set name
- Proxy string
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - Repo
Layout stringRef - Repository layout key for the federated repository
- Tag
Retention int - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- Xray
Index bool - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- key String
- the identity key of the repo.
- members
List<Federated
Helmoci Repository Member> - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - archive
Browsing BooleanEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked
Out Boolean - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn
Redirect Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup
On BooleanDelete - description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download
Direct Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- excludes
Pattern String - 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 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 (**/*
). - Integer
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- notes String
- Internal description.
- priority
Resolution Boolean - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set name
- proxy String
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo
Layout StringRef - Repository layout key for the federated repository
- tag
Retention Integer - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray
Index Boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- key string
- the identity key of the repo.
- members
Federated
Helmoci Repository Member[] - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - archive
Browsing booleanEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked
Out boolean - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn
Redirect boolean - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup
On booleanDelete - description string
- Public description.
- disable
Proxy boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download
Direct boolean - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- excludes
Pattern string - 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 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 (**/*
). - number
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- notes string
- Internal description.
- priority
Resolution boolean - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- project
Environments string[] - project
Key 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.
- property
Sets string[] - List of property set name
- proxy string
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo
Layout stringRef - Repository layout key for the federated repository
- tag
Retention number - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray
Index boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- key str
- the identity key of the repo.
- members
Sequence[Federated
Helmoci Repository Member Args] - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - archive_
browsing_ boolenabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked_
out bool - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn_
redirect bool - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup_
on_ booldelete - description str
- Public description.
- disable_
proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download_
direct bool - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- 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 (**/*
). - int
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- notes str
- Internal description.
- priority_
resolution bool - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- 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.
- property_
sets Sequence[str] - List of property set name
- proxy str
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo_
layout_ strref - Repository layout key for the federated repository
- tag_
retention int - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray_
index bool - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- key String
- the identity key of the repo.
- members List<Property Map>
- The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - archive
Browsing BooleanEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked
Out Boolean - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn
Redirect Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup
On BooleanDelete - description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download
Direct Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- excludes
Pattern String - 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 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 (**/*
). - Number
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- notes String
- Internal description.
- priority
Resolution Boolean - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set name
- proxy String
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo
Layout StringRef - Repository layout key for the federated repository
- tag
Retention Number - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray
Index Boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
Outputs
All input properties are implicitly available as output properties. Additionally, the FederatedHelmociRepository resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Package
Type string
- Id string
- The provider-assigned unique ID for this managed resource.
- Package
Type string
- id String
- The provider-assigned unique ID for this managed resource.
- package
Type String
- id string
- The provider-assigned unique ID for this managed resource.
- package
Type 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.
- package
Type String
Look up Existing FederatedHelmociRepository Resource
Get an existing FederatedHelmociRepository 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?: FederatedHelmociRepositoryState, opts?: CustomResourceOptions): FederatedHelmociRepository
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
archive_browsing_enabled: Optional[bool] = None,
blacked_out: Optional[bool] = None,
cdn_redirect: Optional[bool] = None,
cleanup_on_delete: Optional[bool] = None,
description: Optional[str] = None,
disable_proxy: Optional[bool] = None,
download_direct: Optional[bool] = None,
excludes_pattern: Optional[str] = None,
includes_pattern: Optional[str] = None,
key: Optional[str] = None,
max_unique_tags: Optional[int] = None,
members: Optional[Sequence[FederatedHelmociRepositoryMemberArgs]] = None,
notes: Optional[str] = None,
package_type: Optional[str] = None,
priority_resolution: Optional[bool] = None,
project_environments: Optional[Sequence[str]] = None,
project_key: Optional[str] = None,
property_sets: Optional[Sequence[str]] = None,
proxy: Optional[str] = None,
repo_layout_ref: Optional[str] = None,
tag_retention: Optional[int] = None,
xray_index: Optional[bool] = None) -> FederatedHelmociRepository
func GetFederatedHelmociRepository(ctx *Context, name string, id IDInput, state *FederatedHelmociRepositoryState, opts ...ResourceOption) (*FederatedHelmociRepository, error)
public static FederatedHelmociRepository Get(string name, Input<string> id, FederatedHelmociRepositoryState? state, CustomResourceOptions? opts = null)
public static FederatedHelmociRepository get(String name, Output<String> id, FederatedHelmociRepositoryState 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.
- Archive
Browsing boolEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- Blacked
Out bool - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- Cdn
Redirect bool - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- Cleanup
On boolDelete - Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - Download
Direct bool - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- Excludes
Pattern string - 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 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
- the identity key of the repo.
- int
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- Members
List<Federated
Helmoci Repository Member> - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - Notes string
- Internal description.
- Package
Type string - Priority
Resolution bool - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- Project
Environments List<string> - Project
Key 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.
- Property
Sets List<string> - List of property set name
- Proxy string
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - Repo
Layout stringRef - Repository layout key for the federated repository
- Tag
Retention int - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- Xray
Index bool - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- Archive
Browsing boolEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- Blacked
Out bool - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- Cdn
Redirect bool - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- Cleanup
On boolDelete - Description string
- Public description.
- Disable
Proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - Download
Direct bool - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- Excludes
Pattern string - 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 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
- the identity key of the repo.
- int
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- Members
[]Federated
Helmoci Repository Member Args - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - Notes string
- Internal description.
- Package
Type string - Priority
Resolution bool - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- Project
Environments []string - Project
Key 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.
- Property
Sets []string - List of property set name
- Proxy string
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - Repo
Layout stringRef - Repository layout key for the federated repository
- Tag
Retention int - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- Xray
Index bool - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- archive
Browsing BooleanEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked
Out Boolean - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn
Redirect Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup
On BooleanDelete - description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download
Direct Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- excludes
Pattern String - 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 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
- the identity key of the repo.
- Integer
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- members
List<Federated
Helmoci Repository Member> - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - notes String
- Internal description.
- package
Type String - priority
Resolution Boolean - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set name
- proxy String
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo
Layout StringRef - Repository layout key for the federated repository
- tag
Retention Integer - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray
Index Boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- archive
Browsing booleanEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked
Out boolean - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn
Redirect boolean - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup
On booleanDelete - description string
- Public description.
- disable
Proxy boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download
Direct boolean - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- excludes
Pattern string - 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 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
- the identity key of the repo.
- number
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- members
Federated
Helmoci Repository Member[] - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - notes string
- Internal description.
- package
Type string - priority
Resolution boolean - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- project
Environments string[] - project
Key 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.
- property
Sets string[] - List of property set name
- proxy string
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo
Layout stringRef - Repository layout key for the federated repository
- tag
Retention number - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray
Index boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- archive_
browsing_ boolenabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked_
out bool - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn_
redirect bool - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup_
on_ booldelete - description str
- Public description.
- disable_
proxy bool - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download_
direct bool - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- 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
- the identity key of the repo.
- int
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- members
Sequence[Federated
Helmoci Repository Member Args] - The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - notes str
- Internal description.
- package_
type str - priority_
resolution bool - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- 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.
- property_
sets Sequence[str] - List of property set name
- proxy str
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo_
layout_ strref - Repository layout key for the federated repository
- tag_
retention int - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray_
index bool - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
- archive
Browsing BooleanEnabled - When set, you may view content such as HTML or Javadoc files directly from Artifactory. This may not be safe and therefore requires strict content moderation to prevent malicious users from uploading content that may compromise security (e.g., cross-site scripting attacks).
- blacked
Out Boolean - When set, the repository does not participate in artifact resolution and new artifacts cannot be deployed.
- cdn
Redirect Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from AWS CloudFront. Available in Enterprise+ and Edge licenses only. Default value is 'false'
- cleanup
On BooleanDelete - description String
- Public description.
- disable
Proxy Boolean - When set to
true
, the proxy is disabled, and not returned in the API response body. If there is a default proxy set for the Artifactory instance, it will be ignored, too. - download
Direct Boolean - When set, download requests to this repository will redirect the client to download the artifact directly from the cloud storage provider. Available in Enterprise+ and Edge licenses only.
- excludes
Pattern String - 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 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
- the identity key of the repo.
- Number
- The maximum number of unique tags of a single Docker image to store in this repository. Once the number tags for an image exceeds this setting, older tags are removed. A value of 0 (default) indicates there is no limit. This only applies to manifest v2
- members List<Property Map>
- The list of Federated members and must contain this repository URL (configured base URL
/artifactory/
+ repokey
). Note that each of the federated members will need to have a base URL set. Please follow the instruction to set up Federated repositories correctly. - notes String
- Internal description.
- package
Type String - priority
Resolution Boolean - Setting repositories with priority will cause metadata to be merged only from repositories set with this field
- project
Environments List<String> - project
Key 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.
- property
Sets List<String> - List of property set name
- proxy String
- Proxy key from Artifactory Proxies settings. Default is empty field. Can't be set if
disable_proxy = true
. - repo
Layout StringRef - Repository layout key for the federated repository
- tag
Retention Number - If greater than 1, overwritten tags will be saved by their digest, up to the set up number. This only applies to manifest V2
- xray
Index Boolean - Enable Indexing In Xray. Repository will be indexed with the default retention period. You will be able to change it via Xray settings.
Supporting Types
FederatedHelmociRepositoryMember, FederatedHelmociRepositoryMemberArgs
- Enabled bool
- Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
- Url string
- Full URL to ending with the repository name.
- Access
Token string - Admin access token for this member Artifactory instance. Used in conjunction with
cleanup_on_delete
attribute when Access Federation for access tokens is not enabled.
- Enabled bool
- Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
- Url string
- Full URL to ending with the repository name.
- Access
Token string - Admin access token for this member Artifactory instance. Used in conjunction with
cleanup_on_delete
attribute when Access Federation for access tokens is not enabled.
- enabled Boolean
- Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
- url String
- Full URL to ending with the repository name.
- access
Token String - Admin access token for this member Artifactory instance. Used in conjunction with
cleanup_on_delete
attribute when Access Federation for access tokens is not enabled.
- enabled boolean
- Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
- url string
- Full URL to ending with the repository name.
- access
Token string - Admin access token for this member Artifactory instance. Used in conjunction with
cleanup_on_delete
attribute when Access Federation for access tokens is not enabled.
- enabled bool
- Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
- url str
- Full URL to ending with the repository name.
- access_
token str - Admin access token for this member Artifactory instance. Used in conjunction with
cleanup_on_delete
attribute when Access Federation for access tokens is not enabled.
- enabled Boolean
- Represents the active state of the federated member. It is supported to change the enabled status of my own member. The config will be updated on the other federated members automatically.
- url String
- Full URL to ending with the repository name.
- access
Token String - Admin access token for this member Artifactory instance. Used in conjunction with
cleanup_on_delete
attribute when Access Federation for access tokens is not enabled.
Import
Federated repositories can be imported using their name, e.g.
$ pulumi import artifactory:index/federatedHelmociRepository:FederatedHelmociRepository my-helmoci-federated my-helmoci-federated
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.