Databricks v1.14.0, May 23 23

databricks.Repo

Explore with Pulumi AI

Import

The resource Repo can be imported using the Repo ID (obtained via UI or using API) bash

 $ pulumi import databricks:index/repo:Repo this repo_id

Create Repo Resource

new Repo(name: string, args: RepoArgs, opts?: CustomResourceOptions);

@overload
def Repo(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         branch: Optional[str] = None,
         commit_hash: Optional[str] = None,
         git_provider: Optional[str] = None,
         path: Optional[str] = None,
         sparse_checkout: Optional[RepoSparseCheckoutArgs] = None,
         tag: Optional[str] = None,
         url: Optional[str] = None)
@overload
def Repo(resource_name: str,
         args: RepoArgs,
         opts: Optional[ResourceOptions] = None)

func NewRepo(ctx *Context, name string, args RepoArgs, opts ...ResourceOption) (*Repo, error)

public Repo(string name, RepoArgs args, CustomResourceOptions? opts = null)

public Repo(String name, RepoArgs args)
public Repo(String name, RepoArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args RepoArgs: 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 RepoArgs: 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 RepoArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RepoArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RepoArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Repo Resource Properties

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

Inputs

The Repo resource accepts the following input properties:

Url string: The URL of the Git Repository to clone from. If the value changes, repo is re-created.
Branch string: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
CommitHash string: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
Path string: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
SparseCheckout RepoSparseCheckoutArgs
Tag string: name of the tag for initial checkout. Conflicts with branch.

Url string: The URL of the Git Repository to clone from. If the value changes, repo is re-created.
Branch string: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
CommitHash string: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
Path string: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
SparseCheckout RepoSparseCheckoutArgs
Tag string: name of the tag for initial checkout. Conflicts with branch.

url String: The URL of the Git Repository to clone from. If the value changes, repo is re-created.
branch String: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commitHash String: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path String: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparseCheckout RepoSparseCheckoutArgs
tag String: name of the tag for initial checkout. Conflicts with branch.

url string: The URL of the Git Repository to clone from. If the value changes, repo is re-created.
branch string: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commitHash string: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
gitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path string: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparseCheckout RepoSparseCheckoutArgs
tag string: name of the tag for initial checkout. Conflicts with branch.

url str: The URL of the Git Repository to clone from. If the value changes, repo is re-created.
branch str: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commit_hash str: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
git_provider str: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path str: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparse_checkout RepoSparseCheckoutArgs
tag str: name of the tag for initial checkout. Conflicts with branch.

url String: The URL of the Git Repository to clone from. If the value changes, repo is re-created.
branch String: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commitHash String: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path String: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparseCheckout Property Map
tag String: name of the tag for initial checkout. Conflicts with branch.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Repo Resource

Get an existing Repo 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?: RepoState, opts?: CustomResourceOptions): Repo

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch: Optional[str] = None,
        commit_hash: Optional[str] = None,
        git_provider: Optional[str] = None,
        path: Optional[str] = None,
        sparse_checkout: Optional[RepoSparseCheckoutArgs] = None,
        tag: Optional[str] = None,
        url: Optional[str] = None) -> Repo

func GetRepo(ctx *Context, name string, id IDInput, state *RepoState, opts ...ResourceOption) (*Repo, error)

public static Repo Get(string name, Input<string> id, RepoState? state, CustomResourceOptions? opts = null)

public static Repo get(String name, Output<String> id, RepoState 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:

Branch string: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
CommitHash string: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
Path string: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
SparseCheckout RepoSparseCheckoutArgs
Tag string: name of the tag for initial checkout. Conflicts with branch.
Url string: The URL of the Git Repository to clone from. If the value changes, repo is re-created.

Branch string: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
CommitHash string: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
GitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
Path string: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
SparseCheckout RepoSparseCheckoutArgs
Tag string: name of the tag for initial checkout. Conflicts with branch.
Url string: The URL of the Git Repository to clone from. If the value changes, repo is re-created.

branch String: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commitHash String: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path String: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparseCheckout RepoSparseCheckoutArgs
tag String: name of the tag for initial checkout. Conflicts with branch.
url String: The URL of the Git Repository to clone from. If the value changes, repo is re-created.

branch string: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commitHash string: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
gitProvider string: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path string: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparseCheckout RepoSparseCheckoutArgs
tag string: name of the tag for initial checkout. Conflicts with branch.
url string: The URL of the Git Repository to clone from. If the value changes, repo is re-created.

branch str: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commit_hash str: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
git_provider str: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path str: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparse_checkout RepoSparseCheckoutArgs
tag str: name of the tag for initial checkout. Conflicts with branch.
url str: The URL of the Git Repository to clone from. If the value changes, repo is re-created.

branch String: name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
commitHash String: Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API
gitProvider String: case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.
path String: path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If the value changes, repo is re-created.
sparseCheckout Property Map
tag String: name of the tag for initial checkout. Conflicts with branch.
url String: The URL of the Git Repository to clone from. If the value changes, repo is re-created.

Supporting Types

RepoSparseCheckout

Patterns List<string>

Patterns []string

patterns List<String>

patterns string[]

patterns Sequence[str]

patterns List<String>

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.